Sandboxes

Check if all runtime endpoints of a sandbox are ready

**DEPRECATED** — will be removed in a future version. Prefer `GET /sandboxes/{sandboxId}` and inspect the returned `sandbox.status` (`Running`) plus `sandbox.endpoints` (non-empty, correct scheme/port) instead. Executes the configured ReadinessProbe for each runtime endpoint and returns the aggregated result. Returns 200 when all probes pass, 503 when one or more probes fail. If a runtime has no ReadinessProbe configured, it is considered ready.

GET
/sandboxes/{sandboxId}/is_ready

DEPRECATED — will be removed in a future version.

Prefer GET /sandboxes/{sandboxId} and inspect the returned sandbox.status (Running) plus sandbox.endpoints (non-empty, correct scheme/port) instead.

Executes the configured ReadinessProbe for each runtime endpoint and returns the aggregated result. Returns 200 when all probes pass, 503 when one or more probes fail. If a runtime has no ReadinessProbe configured, it is considered ready.

Authorization

ApiKeyAuth
AGENTBOX-API-KEY<token>

In: header

Path Parameters

sandboxId*string

Sandbox identifier.

  • Single-cluster: a bare UUID v7 such as 5de15c92-8fb5-440f-a9ea-7f62f734f1b9.
  • Cross-cluster: a {clusterID}.{uuid} composite such as cluster1.5de15c92-8fb5-440f-a9ea-7f62f734f1b9 (dot-separated). The clusterID prefix tells the gateway which Worker cluster owns this sandbox; the server parses it out transparently. Discover valid cluster IDs via GET /clusters.

Because of the composite form, this field is NOT a strict RFC 4122 UUID — clients must treat it as an opaque string. Parsing reference: pkg/utils/cluster/sandbox_id.go::SplitSandboxID.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://sandboxes/5de15c92-8fb5-440f-a9ea-7f62f734f1b9/is_ready"
{  "sandboxId": "5de15c92-8fb5-440f-a9ea-7f62f734f1b9",  "ready": true,  "endpoints": {    "property1": {      "ready": true,      "message": "string"    },    "property2": {      "ready": true,      "message": "string"    }  }}
{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}
{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}
{  "sandboxId": "5de15c92-8fb5-440f-a9ea-7f62f734f1b9",  "ready": true,  "endpoints": {    "property1": {      "ready": true,      "message": "string"    },    "property2": {      "ready": true,      "message": "string"    }  }}