Create a sandbox
Creates a Workspace sandbox and returns an Operation; the sandbox is PROVISIONING until the Operation finishes and ACTIVE afterwards. The caller gets the manage permission. With source.type: "sandbox" the new sandbox is a copy of that sandbox from its latest snapshot; the source must be SUSPENDED. Retrying with the same Idempotency-Key returns the same Operation.
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"
Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.
1 - 64"create-prod-2026-05-07"
Body
Display name.
1 - 100"checkout-service"
Compute size. standard is the only size today; larger sizes are added as new values.
standard Where the sandbox content comes from. sandbox: a copy of another sandbox from its latest snapshot (a fork). Repository, snapshot and template sources are added as new type values.
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
Explicit creation is private by default. workspace grants access to every current Workspace member.
private, workspace Workspace-sharing permissions; defaults to run_commands and files. manage stays with the owner unless explicitly included.
1 - 5 elementsrun_commands: commands. files: files. terminal: terminals. previews: previews. manage: all permissions, lifecycle, settings and access grants.
run_commands, files, terminal, previews, manage Response
Sandbox creation started
1 - 531 - 531 - 54Domain entity collection the operation acts on.
install, repository_change_request, repository, workspace, machine, cluster, package, sandbox Prefixed ID of the entity this operation acts on. Prefix matches owner_type (ws_, mch_, clu_, pkg_, inst_, rcr_, repo_, sbx_).
ID of the chained parent operation, when present.
1 - 53Lifecycle state. Past-participle terminal states per AIP-216.
RUNNING, SUCCEEDED, FAILED, CANCELLED True iff state is a terminal value.
Deep link to the dashboard view of this operation's owning resource when available, otherwise the operation detail page.
2048"https://akua.dev/installs/inst_j572abc123def456?tab=operations"
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
- Option 41
- Option 42
- Option 43
Populated only when done && state === "SUCCEEDED". Discriminated by type.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
- Option 41
- Option 42
- Option 43
- Option 44
Populated when state is FAILED or CANCELLED.
Latest error from any failed step. Populated even mid-flight; cleared when the step succeeds on retry.
Unix timestamp (seconds)
x >= 0Unix timestamp (seconds)
x >= 0