Skip to Content
APIHealthz

Healthz

GET /healthz reports whether the gateway is running and whether an agent is connected. It needs no API key, so process managers, load balancers, and monitors can call it.

GET /healthz
{ "ok": true, "agent_connected": false }
FieldMeaning
okThe gateway process is running. Always true with HTTP 200
agent_connectedAn agent is connected. When false, capability calls return AGENT_OFFLINE

Use ok for gateway liveness and alert on agent_connected: false. The endpoint still honors GATEWAY_IP_ALLOW_LIST and the per-source rate limit, so allow your monitoring hosts and keep their polling within the limit.