Skip to main content
POST
/
sandboxes
/
{sandbox_id}
/
pause
Pause Sandbox
curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/pause \
  --header 'X-API-Key: <api-key>'
Transitions the sandbox to the paused state. The underlying Firecracker VM is frozen and memory is preserved. Paused sandboxes do not consume CPU resources. Returns an empty {} body on success.
Resume the sandbox with POST /sandboxes/{sandbox_id}/resume. If auto_resume was set to true in the sandbox’s lifecycle config, it also resumes automatically when accessed.

​
Path Parameters

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

​
Response

Returns an empty JSON object {} on success.

​
Example

curl -X POST https://api.declaw.ai/sandboxes/sbx-a1b2c3d4/pause \
  -H "X-API-Key: YOUR_API_KEY"
Response
{}

​
Error Responses

StatusCause
401Missing or invalid API key
404Sandbox not found
409Sandbox is not in a state that can be paused
500Pause succeeded on orchestrator but Postgres state update failed
502Orchestrator unreachable or returned non-200
503No orchestrator available for the sandbox