Overview
Send new business traffic to an instance only when data.ready is true. An unready instance returns a non-2xx error envelope and must not be treated as available.
Request
This endpoint has no path, query, or request-body parameters.
Response
JSON endpoints use the standard response envelope. HTTP status represents the request outcome; business errors are not disguised as HTTP 200.
| HTTP | Meaning |
|---|---|
200 | Request succeeded |
500 | Internal service error |
503 | Instance is not ready |
Complete success example (optional fields vary by state)
{
"code": 0,
"message": "success",
"data": {
"status": "ok",
"ready": true,
"components": {
"api": {
"status": "ok"
},
"task_store": {
"status": "ok",
"kind": "mysql-runtime"
},
"asset_store": {
"status": "ok",
"kind": "encrypted-private-filesystem"
},
"worker": {
"status": "ok"
},
"shared_worker_runtime": {
"status": "ok",
"kind": "external"
},
"real_channel_routing": {
"status": "ok",
"kind": "external"
},
"scheduler_runtime": {
"status": "ok",
"kind": "advisory"
},
"identity_mirror": {
"status": "ok",
"kind": "advisory"
}
}
},
"request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
"timestamp": "2026-08-10T00:00:00Z"
}Important boundaries
- Public and read-only; it never creates a task or calls an upstream.