Sandboxes
Update sandbox idle timeout
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 ascluster1.5de15c92-8fb5-440f-a9ea-7f62f734f1b9(dot-separated). TheclusterIDprefix tells the gateway which Worker cluster owns this sandbox; the server parses it out transparently. Discover valid cluster IDs viaGET /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.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
timeout*string
New idle timeout duration. Duration string, e.g. '30m', '2h'. Use '0' to disable the timeout.
Response Body
application/json
application/json
application/json
curl -X PUT "https://sandboxes/5de15c92-8fb5-440f-a9ea-7f62f734f1b9/timeout" \ -H "Content-Type: application/json" \ -d '{ "timeout": "30m" }'Empty
{ "error": "string", "errorCode": "API_KEY_REQUIRED", "detail": null}{ "error": "string", "errorCode": "API_KEY_REQUIRED", "detail": null}{ "error": "string", "errorCode": "API_KEY_REQUIRED", "detail": null}