Ciresk Docs
API reference

System

Liveness, readiness, the cell's version and region, and its public status.

GET/health

Check liveness

No credential

Response200 OK

statusstringRequired
curl "$CIRESK_API/health"
GET/ready

Check readiness

Readiness: database, store and listener.

No credential

Response200 OK

dbbooleanRequired
listenerbooleanRequired
storebooleanRequired
curl "$CIRESK_API/ready"
GET/v1/ci/version

Get the cell's version

No credential

Response200 OK

commitstring or null
the short sha of the cell's build; absent from a cell before 2026-10-21
regionstringRequired
the cell a tenant is pinned to. mirrors ciresk_std_api::Region so the api converts a principal's jurisdiction without a second vocabulary.One of eu, us
versionstringRequired
curl "$CIRESK_API/v1/ci/version"
GET/v1/ci/status

Get the cell's status

The cell's public status: a state for the api, job submits and runs.

No credential

Response200 OK

componentsarray of objectsRequired
components[].idstringRequired
api: the answering process's readiness probe (the Ready metric); submit: the share of job submits answered with a 5xx in the last minute (SubmitErrors of SubmitRequests); runs: how long the oldest leasable task has waited (QueueOldestWait)One of api, submit, runs
components[].statestringRequired
One of operational, degraded, outage, unknown
measured_atstring (date-time) or null
the minute tick submit and runs were measured at; absent before this process's first tick, in a cell that writes no metrics, or when the tick is over three minutes old (both are unknown then)
regionstringRequired
the cell a tenant is pinned to. mirrors ciresk_std_api::Region so the api converts a principal's jurisdiction without a second vocabulary.One of eu, us
curl "$CIRESK_API/v1/ci/status"