Skip to main content
POST
Stops a running sandbox, freeing up resources while preserving the sandbox state.

Headers

string
Use with JWT to specify the organization ID

Path Parameters

string
required
ID or name of the sandbox to stop

Response

Returns the updated sandbox object with the new state.
string
The unique identifier of the sandbox
string
The organization ID of the sandbox
string
The name of the sandbox
string
The snapshot used for the sandbox
string
The user associated with the sandbox
object
Environment variables for the sandbox
object
Labels for the sandbox
boolean
Whether the sandbox HTTP preview is public
boolean
Whether all network access is blocked
string
Comma-separated list of allowed CIDR network addresses
string
The target environment for the sandbox
number
The CPU quota for the sandbox
number
The GPU quota for the sandbox
number
The memory quota for the sandbox in GB
number
The disk quota for the sandbox in GB
string
The current state of the sandbox (will be stopping or stopped)Options: stopping, stopped
string
The desired state of the sandbox
number
Auto-stop interval in minutes
number
Auto-archive interval in minutes
number
Auto-delete interval in minutes
array
Array of volumes attached to the sandbox
string
The creation timestamp of the sandbox
string
The last update timestamp of the sandbox
string
The runner ID of the sandbox

Notes

  • Stopping a sandbox frees up compute resources but preserves the sandbox state
  • The sandbox state will transition to stopping and eventually to stopped
  • Stopped sandboxes can be restarted using the start endpoint
  • If autoDeleteInterval is set to 0, the sandbox will be deleted immediately after stopping