system
GET /readyz
Readiness probe — are this instance's workers warm and can it reach its database.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/readyzSigned in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Unauthenticated. 200 when every worker of this instance has finished its boot work and the instance can run a query; 503 otherwise (reason says which), so the orchestrator sends no request to an instance that is still starting or could only fail. Liveness stays on /healthz.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
status | string<ready, not_ready> | Yes | — |
reason | string<database, warming> | No | — |
warm | integer | No | With reason=warming, how many of this instance's workers are warm. |
workers | integer | No | With reason=warming, how many workers must be warm before it is ready. |
version | string | No | — |
Errors this endpoint can return
503