API referenceService
Dependency readiness
GET /readyz
GET https://api.healthcare.dev/readyzReturns 200 when the database and cache are reachable, 503 otherwise.
Public: no API key needed.
Examples
curl
curl "https://api.healthcare.dev/readyz"TypeScript
const res = await fetch("https://api.healthcare.dev/readyz");
const { data, meta } = await res.json();Python
import requests
res = requests.get("https://api.healthcare.dev/readyz")
body = res.json()Try it
Response
Ready
{
"status": "ok",
"checks": {}
}Fields
| Field | Type | Always present | Description |
|---|---|---|---|
status | "ok" | "degraded" | yes | |
checks | object | yes |
Errors
Errors are application/problem+json (RFC 9457). Branch on type, not on title. See Errors.
| Status | type | When |
|---|---|---|
| 503 | dataset-unavailable / unavailable | The dataset has no published version yet, or the service is degraded. |