/api/v1/diagnostics - BlueCat DNS Edge

DNS Edge User Guide (Fleet Service Point)

Locale
English
Product name
BlueCat DNS Edge

Retrieve diagnostics information about the Fleet Service Point.

Request: GET http://<fleet_sp_ip_address>:8083/api/v1/diagnostics

Successful response

200 OK
{
  "corporateHttpProxy": {
    "host": "10.244.149.155",
    "port": "8888",
    "proxyPasswordIsSet": true,
    "scheme": "http",
    "user": "proxyuser"
  },
  "networkConnectivity": {
    "fleetMgmtEndpointErrorMessage": "",
    "fleetMgmtEndpointStatus": 200,
    "internetHttpStatus": 200,
    "internetPingStatus": "OK",
    "localIpStatus": "OK",
    "localNetworkStatus": "OK"
  },
  "registrationStatus": {
    "details": "",
    "state": "REGISTERED"
  }
}
Where the fields represent the following:
  • corporateHttpProxy—the proxy configuration of the Fleet Service Point. The proxy configuration section includes the following information:
    • host—the hostname of the proxy that the Fleet Service Point uses.
    • port—the port that the Fleet Service Point uses to connect to the proxy.
    • proxyPasswordIsSet—indicates whether a proxy password is configured.
    • scheme—the scheme of the proxy.
    • user—the username that is used to authenticate against the proxy server.
  • networkConnectivity—the network connectivity of the Fleet Service Point. The network connectivity section includes the following information:
    • fleetMgmtEndpointErrorMessage—error messages related to the fleetMgmtEndpointStatus test.
    • fleetMgmtEndpointStatus—the status code returned from checking if the Fleet Service Point can connect to the Fleet Management Ingress API gateway.
    • internetHttpStatus—checks if an HTTP request to google.com returns a response.
      Note: This check might fail depending on the environment in which the Fleet Service Point is provisioned.
    • internetPingStatus—checks if ping requests to 8.8.8.8 return a response.
      Note: This check might fail depending on the environment in which the Fleet Service Point is provisioned.
    • localIpStatus—checks if the local network interface is functioning correctly.
    • localNetworkStatus—checks if ping requests to the default IPv4 gateway return a response.
      Note: This check might fail depending on the environment in which the Fleet Service Point is provisioned.
  • registrationStatus—the registration status of the Fleet Service Point. The registration status section includes the following information:
    • details—the details related to the registration status of the Fleet Service Point.
    • state—the registration state of the Fleet Service Point.