Skip to content

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.

FieldTypeDescription
statusstringOne of ok, degraded.
databasestringok, or the error.
redisstringok, or the error.

Errors

StatusCode
401unauthenticated, token_expired, token_replayed, token_not_yet_valid
403permission_denied, app_suspended, quota_exhausted
429rate_limited
500internal

Talkline documentation