Skip to Content
APIHealthz

Healthz

/healthz is the gateway health endpoint. It does not require an API key, so process managers, load balancers, and monitors can check gateway liveness. It is still subject to GATEWAY_IP_ALLOW_LIST and per-source rate limiting; monitoring sources must be allowed and must stay within the configured rate/burst.

Endpoint

GET /healthz

Response

/healthz always returns HTTP 200 while the gateway process is healthy.

{ "ok": true, "agent_connected": false }
FieldDescription
okGateway process is running
agent_connectedWhether one agent is currently connected

Use ok for gateway process liveness. Use agent_connected to alert when the on-prem agent is disconnected and REST / MCP capability calls may return GATEWAY_AGENT_OFFLINE.