API reference
Public & system API
No API key needed: access requests, health and readiness probes, OpenAPI.
Endpoints that do not require an API key: requesting access, liveness and readiness probes, and the OpenAPI document.
Endpoints
- POSTaccess_requestRequest accessAsk for an account. No API key required.Free
- GEThealthHealth checkLiveness probe for load balancers and uptime monitors.Free
- GETreadyReadiness checkReadiness probe: the database is reachable and migrations are applied.Free
- GETopenapi.jsonOpenAPI documentMachine-readable OpenAPI 3 description of the API, with interactive docs at /docs.Free
Access request receipt
Confirms that the request was stored.
idinteger· nullable
Id of the stored request.
statusstring
Always received.
created_atstring (date-time)· nullable
When the request was stored, ISO 8601 in UTC.
Health object
Liveness report. Not wrapped in the response envelope.
statusstring
ok, or degraded when the database cannot be reached.
databaseboolean
Whether the database answered.
queueobject
Kept for older clients; always empty.
rate_limitsobject
Kept for older clients; always empty.
Readiness object
Readiness report. Not wrapped in the response envelope.
statusstring
ready or not_ready.
databaseboolean
Whether the database answered.
pending_migrationsarray of strings
Database migrations that are not applied yet (empty when ready).