API reference
Get Health
GET /health
GET
/healthOperational readiness. A degraded response uses the health envelope, not an execution error.
Authentication
This endpoint does not require an API key.
Responses
200
Healthy
application/json
| Field | Type | Required | Description |
|---|---|---|---|
status | "ok" · "degraded" | Yes | |
service | string | Yes | |
timestamp | string | Yes | |
uptime_seconds | integer | Yes | |
checks | object | Yes |
Full schema:
{
"type": "object",
"properties": {
"status": {
"enum": [
"ok",
"degraded"
]
},
"service": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"uptime_seconds": {
"type": "integer"
},
"checks": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"status",
"service",
"timestamp",
"uptime_seconds",
"checks"
],
"additionalProperties": false
}
503
Degraded
application/json
| Field | Type | Required | Description |
|---|---|---|---|
status | "ok" · "degraded" | Yes | |
service | string | Yes | |
timestamp | string | Yes | |
uptime_seconds | integer | Yes | |
checks | object | Yes |
Full schema:
{
"type": "object",
"properties": {
"status": {
"enum": [
"ok",
"degraded"
]
},
"service": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"uptime_seconds": {
"type": "integer"
},
"checks": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"status",
"service",
"timestamp",
"uptime_seconds",
"checks"
],
"additionalProperties": false
}