Appearance
Health
Whether the API reaches what it depends on.
Whether this API reaches its database and Redis
GET /v1/health
Authenticated like everything else. Probes use the internal listener.
Credential: API key — Authorization: Bearer <api_key>.<api_secret>
Rate limit: read, 600 a minute
Response 200 — The API's view of its dependencies.
| Field | Type | Description |
|---|---|---|
status | string | One of ok, degraded. |
database | string | ok, or the error. |
redis | string | ok, or the error. |
Errors
| Status | Code |
|---|---|
| 401 | unauthenticated, token_expired, token_replayed, token_not_yet_valid |
| 403 | permission_denied, app_suspended, quota_exhausted |
| 429 | rate_limited |
| 500 | internal |