Sandboxes

Get sandbox logs

GET
/sandboxes/{sandboxId}/logs

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.

Query Parameters

container?string

Filter by container name. When omitted, logs from all containers are returned.

lines?integer

Return only the last N lines. 0 or absent means return all lines.

Range0 <= value <= 10000
source?string

Log source selector.

  • Omit or "stdout": return container stdout/stderr (default behavior)
  • "<runtime_name>": read the runtime's log file (logDir) via exec inside the container. Only available for Running sandboxes with a matching runtime that has logDir set.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sandboxes/5de15c92-8fb5-440f-a9ea-7f62f734f1b9/logs"
{  "sandboxId": "5de15c92-8fb5-440f-a9ea-7f62f734f1b9",  "namespace": "string",  "podName": "string",  "capturedAt": "2019-08-24T14:15:22Z",  "entries": [    {      "timestamp": "2019-08-24T14:15:22Z",      "container": "string",      "log": "string"    }  ],  "truncated": true,  "totalBytes": 0,  "source": "live",  "runtimeName": "string"}
{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}
{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}
{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}
{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}

Get a sandbox GET

Previous Page

Check if all runtime endpoints of a sandbox are ready GET

**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.