/v1/status/health - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide
ft:locale
en-US
Product name
BlueCat Edge
Version
Service Point v4.x.x
The health probe API reflects the internal state of the DNS resolver service's critical path for handling DNS queries on Service Point v4 instances. The health of the DNS resolver service 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 DNS resolver service.

The health probe can be used when configuring the Service Point v4 instance behind load balancers.

Request: GET http://<spv4-ip-address>:2021/v1/status/health

Where the <spv4-ip-address> is the IP address of the Service Point v4 instance.

Successful response

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