Skip to content

Liveness + dependency health probe

GET
/v1/health

Returns 200 with a per-dependency boolean map when postgres + redis are reachable; 503 with the same shape when at least one dependency is down. Unauthenticated — suitable for uptime probes. Response keys (postgres, redis) are stable across releases; new dependencies will be added without breaking existing keys.

All dependencies healthy.

object
status
required
string
Allowed values: ok degraded
checks

Per-dependency boolean map — e.g. { postgres: true, redis: true }. Keys stable across releases.

object
key
additional properties
boolean
{
"status": "ok",
"checks": {
"postgres": true,
"redis": true
}
}

One or more dependencies unhealthy.

object
status
required
string
Allowed values: ok degraded
checks

Per-dependency boolean map — e.g. { postgres: true, redis: true }. Keys stable across releases.

object
key
additional properties
boolean
{
"status": "ok",
"checks": {
"postgres": true,
"redis": true
}
}