Skip to main content
POST
/
sandboxes
/
{sandboxID}
/
pause
Pause sandbox
curl --request POST \
  --url https://api.e2b.app/sandboxes/{sandboxID}/pause \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "memory": true
}'
{
  "code": 123,
  "message": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
sandboxID
string
required

Body

application/json
​
memory
boolean
default:true

Whether to capture a full memory snapshot. When false, only the filesystem is persisted and resuming the sandbox cold-boots (reboots) it from disk, losing in-memory state, running processes, and open connections. Resume it with an explicit request (connect or resume); auto-resume, which can be triggered by arbitrary traffic, refuses such a sandbox. Defaults to true.

Response

The sandbox was paused successfully and can be resumed