Health
Orchestration probes. These two live outside the /v1 prefix and need no credential.
GET /health/live
Section titled “GET /health/live”Liveness
Auth: None: verifies the caller’s own signature/token.
Response 200
{ "data": { "status": "ok" }, "meta": { "requestId": "string", "nextCursor": "string", "hasMore": true }}| Field | Type | Required | Constraints |
|---|---|---|---|
data |
object | yes | |
data.status |
“ok” | yes | |
meta |
object | no | |
meta.requestId |
string | no | |
meta.nextCursor |
string | null | no | |
meta.hasMore |
boolean | no |
Errors follow the shared envelope and code table.
GET /health/ready
Section titled “GET /health/ready”Readiness, with per-dependency checks
Auth: None: verifies the caller’s own signature/token.
Response 200
{ "data": { "status": "ok", "checks": { "key": true } }, "meta": { "requestId": "string", "nextCursor": "string", "hasMore": true }}| Field | Type | Required | Constraints |
|---|---|---|---|
data |
object | yes | |
data.status |
“ok” | yes | |
data.checks |
record<string, boolean> | yes | |
meta |
object | no | |
meta.requestId |
string | no | |
meta.nextCursor |
string | null | no | |
meta.hasMore |
boolean | no |
Errors follow the shared envelope and code table.