Update a sandbox
Changes name, size, network policy, idle timeout or labels. Requires manage. A new idle timeout applies from the next activity.
Authorizations
workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens
Headers
Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.
1 - 53"ws_j572abc123def456"
The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.
1 - 256"42"
Path Parameters
Sandbox id (sbx_...).
^sbx_[A-Za-z0-9]{1,64}$"sbx_j572abc123def456"
Body
Display name.
1 - 100"checkout-service"
Compute size. standard is the only size today; larger sizes are added as new values.
standard Outbound network access. allow_all: HTTP and HTTPS to public internet addresses; private, link-local and cluster-internal addresses are always blocked, and other protocols except DNS are not forwarded. Restrictive modes are added as new values.
Seconds without API activity after which the sandbox suspends itself. Commands that are still running keep it awake. 300 to 86400; default 600.
300 <= x <= 86400600
Response
Sandbox
Sandbox id (sbx_...).
^sbx_[A-Za-z0-9]{1,64}$"sbx_j572abc123def456"
1 - 53Display name.
1 - 100"checkout-service"
ACTIVE sandboxes run commands and file operations. SUSPENDED sandboxes keep their files and cost only storage. -ING states are in flight; FAILED sandboxes can only be deleted.
PROVISIONING, ACTIVE, SUSPENDING, SUSPENDED, RESUMING, DELETING, FAILED Compute size. standard is the only size today; larger sizes are added as new values.
standard null for a sandbox created empty.
Outbound network access. allow_all: HTTP and HTTPS to public internet addresses; private, link-local and cluster-internal addresses are always blocked, and other protocols except DNS are not forwarded. Restrictive modes are added as new values.
Seconds without API activity after which the sandbox suspends itself. Commands that are still running keep it awake. 300 to 86400; default 600.
300 <= x <= 86400600
Why the sandbox is FAILED; null otherwise.
Last API activity (Unix seconds).
x >= 0Creation time (Unix seconds).
x >= 0Last change (Unix seconds).
x >= 0Opaque version token. Send it as If-Match on writes.