Health check (readiness)

GET

/api/health

Deep readiness check: verifies the database, Redis and the event bus, and answers 503 when any of them is degraded. Returns minimal status for unauthenticated requests; provide a valid API key for per-dependency detail. Costs one database round-trip and one Redis PING per call — probe GET /api/health/live instead for container liveness.

Responses

All systems healthy

Content-Type

application/json

{

  

"status": "string",

  

"service": "string",

  

"checks": {

  

  

"database": {

  

  

  

"status": "string",

  

  

  

"latencyMs": 0,

  

  

  

"error": "string"

  

  

},

  

  

"redis": {

  

  

  

"status": "string",

  

  

  

"latencyMs": 0,

  

  

  

"error": "string"

  

  

},

  

  

"eventBus": {

  

  

  

"status": "string",

  

  

  

"latencyMs": 0,

  

  

  

"error": "string"

  

  

}

  

}

}

GET

/api/health

Samples