Skip to main content
POST
/
sandboxes
/
{sandbox_id}
/
resume
Resume Sandbox
curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/resume \
  --header 'X-API-Key: <api-key>'
{
  "resumed": true,
  "sandbox_id": "<string>",
  "node_id": "<string>",
  "snapshot_id": "<string>"
}
Resumes a sandbox that is currently in the paused state. The server picks the best available snapshot (preference: pauseperiodicmanual) and restores the VM on an available node. The restored sandbox may run on a different worker than the original. Only sandboxes in the paused state can be resumed. On success the sandbox transitions back to live.

Path Parameters

sandbox_id
string
required
The sandbox identifier. Format: sbx-<8 chars>.

Response

resumed
boolean
Always true when the response is 200.
sandbox_id
string
The sandbox that was resumed.
node_id
string
The node the sandbox now runs on.
snapshot_id
string
The snapshot that was used to restore.

Example

curl -X POST https://api.declaw.ai/sandboxes/sbx-a1b2c3d4/resume \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "resumed": true,
  "sandbox_id": "sbx-a1b2c3d4",
  "node_id": "node-42",
  "snapshot_id": "snap-a1b2c3d4"
}

Error Responses

StatusCause
401Missing or invalid API key
404Sandbox not found, or no snapshot available to resume from
409Sandbox is not paused
500Restore succeeded on orchestrator but Postgres state update failed
502Orchestrator unreachable or restore failed
503No orchestrator or node available