Skip to main content
POST
Resume sandbox

Authorizations

X-API-Key
string
header
required

Path Parameters

sandboxID
string
required

Body

application/json
timeout
integer<int32>
default:15

Time to live for the sandbox in seconds.

Required range: x >= 0
cpuCount
integer<int32>

Online vCPU target for the resumed sandbox. Defaults to the snapshot's cpuCount; at most the template's maxCpuCount (fixed-size templates accept only their cpuCount).

Required range: x >= 1
autoPause
boolean
deprecated

Automatically pauses the sandbox after the timeout

memory
boolean

Defaults to true. When false, resume from disk state only: the sandbox cold-boots fresh and any memory in the snapshot is ignored, never modified or deleted. Disk state has crash-recovery semantics — writes not flushed before the pause may be lost. A no-op for snapshots that contain no memory. Rejected with an error in environments where this capability is not enabled, never silently downgraded to a memory restore. A snapshot taken while the sandbox guest agent was not responding (envdUnresponsiveAtPause) can only be resumed this way, and needs no enablement.

Response

The sandbox was resumed successfully

templateID
string
required

Identifier of the template from which is the sandbox created

sandboxID
string
required

Identifier of the sandbox

clientID
string
required
deprecated

Identifier of the client

envdVersion
string
required

Version of the envd running in the sandbox

alias
string

Alias of the template

envdAccessToken
string

Access token used for envd communication

trafficAccessToken
string | null

Token required for accessing sandbox via proxy.

domain
string | null

Base domain where the sandbox traffic is accessible