API reference

Health

Operational. Not part of the partner contract.

Operations

OperationWhat it doesScope
GET/healthLiveness check (does not touch dependencies)
GET/health/readyReadiness check (database only)
GET/health/fullPer-dependency state (no internal detail)

A key that lacks one of these scopes is refused with 403 insufficient_scope, and error.missingScope names the one it was missing. Scopes are fixed when the key is issued.

Shared across these operations

The error envelope and the full list of error types are the same for every operation in the API, as are the object schemas the responses are built from. Neither is repeated per page.