Through the gateway, probe keyless at GET /api/health; the versioned /api/v1/health below sits behind the gateway's authenticated /api/v1/ route and needs an X-API-Key.

GET

/api/v1/health

GET

/api/v1/health

Response Body

Successful Response

application/json

response

status*Status

ok, degraded, or unhealthy (unhealthy is served as 503).

storage*Storage

connected or unreachable.

redis*Redis

connected, unavailable, or not configured.

event_bus*Event Bus

ok, unhealthy, or error.

platform_init_errors?array<string>|

Only when platform init recorded errors and all dependencies are up (status=degraded).

unhealthy_dependencies?array<string>|

Only on 503: names of failing dependencies.

Example Request

curl -X GET 'https://example.com/api/v1/health'

Example Request

curl -X GET 'https://example.com/api/v1/health'

Example ResponseSchema

{
  "status": "string",
  "storage": "string",
  "redis": "string",
  "event_bus": "string",
  "platform_init_errors": [
    "string"
  ],
  "unhealthy_dependencies": [
    "string"
  ]
}

{  "status": "string",  "storage": "string",  "redis": "string",  "event_bus": "string",  "platform_init_errors": [    "string"  ],  "unhealthy_dependencies": [    "string"  ]}

Health

Response BodyCopy Anchor Link

Response Body