staqlydocs
REST APIAPI referenceSystem

Readiness probe

Readiness probe

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/readyz

Checks the database (ping), that every embedded migration is applied, and that the background workers are running (heartbeat newer than 30s). workers is not_started (not a failure) when the process runs no background workers.

Response Body

Ready

application/json
  1. response
status*string
Value in"ok""unavailable"
checks*
curl -X GET 'https://staqly.example.com/readyz'
{  "status": "ok",  "checks": {    "database": "ok",    "migrations": "string",    "workers": "ok"  }}