Skip to main content
GET
/
readyz
Readiness probe
curl --request GET \
  --url https://api.usezombie.com/readyz
{
  "ready": true,
  "database": true,
  "worker": true,
  "queue_dependency": true,
  "queue_depth": 123,
  "queue_depth_breached": true,
  "queue_age_breached": true,
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "oldest_queued_age_ms": 123,
  "queue_depth_limit": 123,
  "queue_age_limit_ms": 123
}

Response

200 - application/json

Readiness status with dependency details

​
ready
boolean
required

Overall readiness — true only when all dependencies are healthy

​
database
boolean
required

Database connection pool is healthy

​
worker
boolean
required

Background worker process is responsive

​
queue_dependency
boolean
required

Queue backend is reachable

​
queue_depth
integer
required

Current number of items in the work queue

​
queue_depth_breached
boolean
required

True if queue depth exceeds the configured limit

​
queue_age_breached
boolean
required

True if oldest queued item exceeds the configured age limit

​
request_id
string<uuid>
required

Unique request identifier

​
oldest_queued_age_ms
integer | null

Age in milliseconds of the oldest queued item, null if queue is empty

​
queue_depth_limit
integer | null

Configured queue depth threshold, null if unconfigured

​
queue_age_limit_ms
integer | null

Configured queue age threshold in milliseconds, null if unconfigured