Skip to content
Readsmith

Health check

GET/docs/_readsmith/api/health

Liveness plus database reachability. A site running docs-only reports the database as disabled and stays healthy.

Responses
200 OKHealthy.
Health
statusstringrequired
Allowed values
okdegraded
databasestringrequired
Allowed values
updowndisabled
503 UnavailableThe database is configured but unreachable.
Health
statusstringrequired
Allowed values
okdegraded
databasestringrequired
Allowed values
updowndisabled
Request
GET/docs/_readsmith/api/health
cURL
curl 'https://readsmith.dev/docs/_readsmith/api/health'
GET/_readsmith/api/health
Request
Authorization
curl 'https://readsmith.dev/docs/_readsmith/api/health'
Response
Send a request to see the response.
Response
200 OK
{
  "status": "ok",
  "database": "up"
}
Was this page helpful?