GET bam/v1/health - BlueCat Address Manager - 9.3.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.3.0

Description

Returns the health status of Address Manager. This API can be called on primary, secondary, or standalone Address Manager servers.

Headers

Key Description
Content-Type
Defines the format of the response returned from the API. The Content-Type header can be set to one of the following values:
  • */* - returns the response in JSON format
  • application/json - returns the response in JSON format
  • application/xml - returns the response in XML format

Parameters

Name Description
timeout

Location: query

Type: integer (int64)

The timeout of this request in milliseconds. The default value is 3000.

Example Output

{
   "status":"UP",
   "details":{
      "notification":{
         "status":"UP",
         "details":{
            "processed":7,
            "ongoing":0,
            "queued":0,
            "unprocessedNotificationsSize":10,
            "lastPersistedMessageTimestamp":"Fri Apr 09 01:00:44 EDT 2021"
         }
      },
      "disk":{
         "status":"UP",
         "details":{
            "total":20317863936,
            "free":16350126080,
            "threshold":10485760
         }
      },
      "process":{
         "status":"UP",
         "details":{
            "state":"STARTED",
            "version":"9.4.0",
            "uptime":557842
         }
      },
      "memory":{
         "status":"UP",
         "details":{
            "free":77621248,
            "total":141557760
         }
      },
      "localConnectivity":{
         "status":"UP",
         "details":{
            "database":{
               "status":"UP"
            },
            "ui":{
               "status":"UP",
               "details":{
                  "httpsStatus":200,
                  "httpsResponseTime":1048,
                  "httpStatus":200,
                  "httpResponseTime":1098
               }
            },
            "restApi":{
               "status":"UP",
               "details":{
                  "httpsStatus":200,
                  "httpsResponseTime":796,
                  "httpStatus":200,
                  "httpResponseTime":852
               }
            },
            "soapApi":{
               "status":"UP",
               "details":{
                  "httpStatus":200,
                  "httpResponseTime":564,
                  "httpsStatus":200,
                  "httpsResponseTime":503
               }
            }
         }
      },
      "primaryConnectivity":{
         "status":"N/A",
         "details":{
            "database":{
               "status":"N/A"
            },
            "ui":{
               "status":"N/A"
            },
            "restApi":{
               "status":"N/A"
            },
            "soapApi":{
               "status":"N/A"
            }
         }
      },
      "replicationMetrics":{
         "status":"UP",
         "details":{
            "replication":{
               "status":"UP",
               "details":{
                  "replicationRole":"Primary",
                  "replicationLatencyWarningThreshold":"100",
                  "replicationLatencyCriticalThreshold":"200",
                  "primary":{
                     "hostname":"port1.bcn.com",
                     "ipAddress":"172.40.221.101",
                     "status":"Replicating",
                     "latency":"0"
                  },
                  "standby1":{
                     "hostname":"port2.bcn.com",
                     "ipAddress":"172.40.221.102",
                     "status":"Replicating",
                     "latency":"0"
                  }
               }
            },
            "watermark":{
               "status":"UP",
               "details":{
                  "replicationLag":"0"
               }
            }
         }
      },
      "cpu":{
         "status":"UP",
         "details":{
            "processCpuLoad":"0.00%",
            "systemCpuLoad":"100.00%",
            "heapMemoryUsed":302503144,
            "nonHeapMemoryUsed":204351256
         }
      },
      "deployment":{
         "status":"UP",
         "details":{
            "ongoing":0,
            "queued":0
         }
      }
   }
}

Responses

Code Description
200

Type: string

Returns the health status of Address Manager.