Skip to main content
POST
Pause Sandbox
Transitions the sandbox to the paused state. The underlying sandbox VM is frozen and memory is preserved. Paused sandboxes do not consume CPU resources. Returns {"paused": true, "sandbox_id": "<id>"} on success.
Resume the sandbox with POST /sandboxes/{sandbox_id}/resume. A sandbox created with lifecycle.on_timeout: "pause" is paused this same way when its timeout fires, instead of being killed.

Path Parameters

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

Response

boolean
Always true on success.
string
The paused sandbox’s identifier.

Example

Response

Error Responses