Pause a sandbox

POST

sandboxes

{id}

pause

Pause a sandbox

curl --request POST \
  --url https://sandbox.brimble.io/sandboxes/{id}/pause \
  --header 'x-brimble-key: <api-key>'

{
  "message": "Sandbox pause requested"
}

Authorizations

x-brimble-key

string

header

required

Your account-level Brimble API key. Find it in the dashboard under your profile drawer → API key (click the avatar in the sidebar). Available on paid plans only.

Path Parameters

string

required

24-char hex id of the sandbox.

Pattern: ^[a-f0-9]{24}$

Response

Pause queued

message

string

required

Example:

"Sandbox pause requested"

Last modified on May 20, 2026

Resume a paused sandboxStarts a fresh container of the same template and reattaches the persistent volume. Files under the sandbox's workspace directory come back; nothing else does. Sandbox must be in status `paused`. `status` transitions from `paused` to `ready` once the container is up.

Pause a sandbox

curl --request POST \
  --url https://sandbox.brimble.io/sandboxes/{id}/pause \
  --header 'x-brimble-key: <api-key>'

{
  "message": "Sandbox pause requested"
}