Health API - BlueCat Edge - Service Point v3.x.x

BlueCat Edge User Guide
Locale
English
Product name
BlueCat Edge
Version
Service Point v3.x.x
The health probe API reflects the internal state of the service point's critical path for handling DNS queries. The health of the service point is determined by the following:
  • Whether the dns-gateway-service is healthy.
  • Whether a version.bind query made from the status-service to the dns-gateway-service is resolved and responds with NOERROR.
    Note: The query is internal and handled by the dns-gateway-service. This query is not forwarded out of the service point.

The health probe can be used when configuring the BlueCat Edge service point behind load balancers.

Request: GET http://<sp-ip-address>:80/v1/status/health

Where the <sp-ip-address> is the IP address of the service point.

Successful response

200 OK
Possible error codes
  • 500 INTERNAL SERVER ERROR - One or more health checks failed.