OpenAPI reference · Health
Public health probe
GET
/healthReports the status of the API + its critical dependencies (DB,
Redis, audit buffer). Returns 200 when all OK, 503 with
status: degraded when any dependency is unhealthy.
Cached for 5 seconds via Cache-Control: public, max-age=5.
Bypasses authentication and rate limiting — safe for monitors.
Responses
- 200
All dependencies healthy.
- 503
One or more dependencies degraded.
Example request
bash
curl --request GET \
--url 'https://api.scripe.io/v1/health'Example response (200)
json
{
"status": "ok",
"version": "2026-08-10",
"checks": {
"db": {
"ok": true,
"latencyMs": 0
},
"redis": {
"ok": true,
"latencyMs": 0
},
"auditBuffer": {
"ok": true,
"depth": 0
}
}
}