Skip to main content

HealthResponse

Health check response with dependency status

statusstringrequired

Possible values: [healthy, degraded, unhealthy]

timestampstring<date-time>required
versionstringrequired
checks object
databasestringrequired

Possible values: [ok, error]

redisstringrequired

Possible values: [ok, error]

queuestringrequired

Possible values: [ok, error]

HealthResponse
{
"status": "healthy",
"timestamp": "2024-01-15T10:30:00Z",
"version": "1.0.0",
"checks": {
"database": "ok",
"redis": "ok",
"queue": "ok"
}
}
Was this page helpful?