curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/pause' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wait": true,
"timeout_seconds": 120,
"auto_resume": true
}'
Pause a running sandbox (snapshot mode: durable only; filesystem kept, memory…
Sandbox paused (or already paused)
POST
/
api
/
v1
/
sandbox
/
{id}
/
pause
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/pause' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wait": true,
"timeout_seconds": 120,
"auto_resume": true
}'
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Path parameters
string (uuid)
required
Sandbox identifier
Request body
PauseResumeSandboxRequest
boolean
Wait for the transition (default true); false answers 202 at once. Default:
true.integer
Longest wait before answering 202 with the transition still running (max 120). Minimum:
1. Maximum: 120.boolean
Pause only: a later exec/files/processes/REPL call resumes the sandbox on its own (default false).
Response
No response body. Sandbox paused (or already paused).Status codes
| Code | Meaning |
|---|---|
200 | Sandbox paused (or already paused) |
202 | Pause in progress (wait=false, or the wait ran out) |
400 | Pause/resume not enabled (FEATURE_DISABLED) |
404 | Sandbox not found |
409 | SANDBOX_NOT_PAUSABLE (not durable, or the org paused limit) or SANDBOX_INVALID_STATE |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/pause' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"wait": true,
"timeout_seconds": 120,
"auto_resume": true
}'
Last modified on October 20, 2026