Skip to main content
GET
Platform liveness check

Response

200 - application/json

Platform is live (or partially degraded, inspect degraded_subsystems).

Unauthenticated liveness response. This payload requires no credentials and contains no tenant-scoped data. The degraded_subsystems array is empty when the service is nominal, and lists the affected subsystems otherwise.

ok
boolean
required

Always true on HTTP 200, the platform is reachable.

status
enum<string>
required

up = all subsystems nominal. degraded = one or more subsystems impaired but platform is still serving.

Available options:
up,
degraded
degraded_subsystems
string[]
required

Named subsystems currently impaired (e.g. ['promo_engine', 'webhook_fanout']). Empty when status is up.

Example: