Skip to main content

Health

Two checks. Both need no authentication, and both live at the root, not under /api/v1.

Liveness​

GET /health

Returns 200 while the API process runs. It checks no dependency, so it stays 200 during a database or Redis outage.

{ "status": "ok" }

Readiness​

GET /ready

Checks that the API can reach Redis and Postgres. It returns 200 when both answer:

{ "status": "ok", "redis": "connected", "postgres": "connected" }

If a dependency does not answer within 1 second, it returns 503 with status: "degraded" and the failing dependency marked disconnected:

{ "status": "degraded", "redis": "connected", "postgres": "disconnected" }

Use /ready for uptime checks that must see a dependency outage. Use /health to see only whether the process runs.