Skip to main content

Check the API server health

GET 

/healthz

Checks the components that the API server depends on, PostgreSQL, NATS JetStream, the Redis-compatible cache and the gRPC service, and returns a health report in JSON with the status of each component. Each check has a time limit of 3 seconds, after which the component is reported as error. The status code is 200 when every component is ok and 503 when any component reports error, so the operation suits readiness probes. A liveness probe uses GET / instead, so that an outage of a shared component does not restart every API server.

Permissions. None. The operation requires no API key.

Responses​

Every component is reachable. The body is the health report, with ok in every field.