Skip to content
On this page

Health

Service health

Health check

GET /api/health

Public endpoint: no Bearer token and no X-Organization-Id header.

No API token scope required.

The overall status of the service, and nothing else: healthy, degraded (serving, with something to look at) or unhealthy. The answer is cached for 30 seconds, and the endpoint is rate-limited to 30 requests a minute per client IP.

Responses

Status Description
200 Serving: healthy or degraded.
503 Unhealthy: a check failed.
429 Too many requests from this client IP (more than 30 a minute).

Example request

curl -X GET "https://kworia.com/api/health" \
  -H "Accept: application/json"