Health Check HTTP

Advanced topic

Similar to the WebSocket API, the Agent exposes a plain HTTP interface on its listening port. You can contact it through either HTTP or HTTPS depending on your Agents SSL configuration.

When running a default Agent configuration, you can locally test the Health Checking endpoint by accessing `https://127.0.0.1:8090\` in your browser or requesting it through your command line.

When trying to reach it externally, you need to exchange `127.0.0.1` with your devices external ip.

The health check will respond with a JSON formatted response of the following format

{
  agent: {
    version: <str>
    ssl: <bool>
  }
  system: {
    hostname: <str>
  }
  status: <str>
  cloud_controller: {
    connected: <bool>
    usable: <bool>
    status: <str>
  }
}

status is running while the HTTP server is up.

cloud_controller.status is one of connecting, unreachable, connected, connection_lost, authentication_failure, or backoff. cloud_controller.connected is true only while the controller session is up.

cloud_controller.usable is true after Cloud Controller authentication has succeeded once. It stays true if the connection drops later. It is false after an authentication failure.