ReferenceHTTP APIHealth

DB, schema and config readiness

GET
/readyz

Runs the readiness checks in order and stops at the first failure: database (the database answers), schema (the applied migrations include every migration of this build) and config (required settings and limits are valid). Use it as a readiness probe: a 503 means do not route traffic here. The execution backend is not checked. From the moment the process starts shutting down it answers 503 too.

Auth: public; no credential.

Response Body

Every check passed.

application/json
  1. response
status*string
checks*
Example Request
curl -X GET 'https://example.com/readyz'
Example Response
{  "status": "ready",  "checks": {    "database": "ok",    "schema": "ok",    "config": "ok"  }}