Skip to content
LabelyardLabelyardLabelyard

Readiness probe

GET
/readiness
curl --request GET \
  --url https://example.com/readiness \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

Deep readiness check: database connectivity, alembic migration state, printer wiring, SNMP probe recency, print-queue liveness, SSE subscriber capacity, and stuck render slots (render_slots: page renders past LABELYARD_RENDER_TIMEOUT_S whose thread still runs; fails when every slot is stuck, a hub restart frees them). Returns 200 with status in {ready, degraded} when all critical checks pass; 503 with status=not-ready when any critical check (database / alembic) fails.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ReadinessResponse
object
checks
required
Checks
object
key
additional properties
CheckStatus
object
detail
Detail
Any of:
string
metric
Metric
Any of:
object
key
additional properties
any
status
required
Status
string
Allowed values: ok fail skipped stale
revision
required
Revision
string
status
required
Status
string
Allowed values: ready degraded not-ready
version
required
Version
string

Example 

{
  "checks": {
    "additionalProperty": {
      "status": "ok"
    }
  },
  "status": "ready"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
ReadinessResponse
object
checks
required
Checks
object
key
additional properties
CheckStatus
object
detail
Detail
Any of:
string
metric
Metric
Any of:
object
key
additional properties
any
status
required
Status
string
Allowed values: ok fail skipped stale
revision
required
Revision
string
status
required
Status
string
Allowed values: ready degraded not-ready
version
required
Version
string

Example 

{
  "checks": {
    "additionalProperty": {
      "status": "ok"
    }
  },
  "status": "ready"
}