health

health status

Health status endpoint. Returns cached health status (database connectivity, worker count). Cache TTL is fixed at 5 seconds. Use force=true query parameter to bypass cache. Note: This endpoint is intentionally different from Kubernetes probes to avoid confusion. For k8s liveness/readiness probes, use /version endpoint.

get/health/status

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/health/status
  • Auth: none required

Query parameters

forceboolean

Force a fresh check, bypassing the cache

Response

server is healthy or degraded

status'healthy' | 'degraded' | 'unhealthy' required

Overall health status

checked_atstring date-time required

Timestamp when the health check was actually performed (not cache return time)

database_healthyboolean required

Whether the database is reachable

workers_aliveinteger required

Number of workers that pinged within last 5 minutes

Changes

No recorded changes to this operation across all 297 revisions of this API.