Skip to main content
POST
Pause sandbox

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.

requireHealthyGuest
boolean
default:false

The pause checks that the sandbox guest agent answers before it takes the snapshot. By default an unresponsive agent is recorded on the snapshot and the pause proceeds; the sandbox then shows envdUnresponsiveAtPause and a later resume must ask for memory: false, since restoring that memory would bring the unresponsive agent back. With this true, the pause is instead refused with 503 while the agent does not answer, and the sandbox keeps running. A filesystem-only pause (memory: false) is always refused while the agent does not answer, whatever this says.

Response

The sandbox was paused successfully and can be resumed