Health Check HTTP

Architect Agents HTTP endpoint for external health checks
Written by Philipp
Updated 2 weeks ago
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> (always "running")
}

Did this answer your question?