API
Check service liveness
GET /health — Check service liveness
Operation
GET /health
Behavior
Lightweight liveness probe: returns {"status": "ok"} whenever the API process is up and serving requests.
- It checks no databases or other dependencies, so a
200here does not guarantee that data endpoints are available. UseGET /statusfor service health history. - The body is returned as-is, without the usual
data/metaenvelope.
Usage
{
"authentication": "public",
"credit_cost": 0,
"premium": false,
"recommended_interval_seconds": 30,
"rate_limit": null,
"unit_pricing": null
}Request
{}Responses
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthOut"
}
}
}
}
}Models
{
"HealthOut": {
"properties": {
"status": {
"type": "string",
"title": "Status",
"description": "Always `ok` while the service is running."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"status"
],
"title": "HealthOut",
"description": "Liveness result. Returned as a bare object, without the response envelope."
}
}