Pause a sandbox

POST

/v1/sandbox/{sandboxID}/pause

• Production

Pause a running sandbox. The sandbox’s VM state, memory, and disk are captured and uploaded, the sandbox is marked as paused, and the VM is terminated. The sandbox can later be resumed via the invoke route or the resume endpoint, which restores it from the saved state. Unlike /snapshot/pause, this does not create a named snapshot.

Authorizations

• BearerAuth

Parameters

Path Parameters

sandboxID

required

string

Unique sandbox identifier.

Responses

201

Sandbox paused successfully.

object

id

required

Unique sandbox identifier.

string

Example

sbx-abc123

template_id

required

Template the sandbox was created from.

string

vcpu

required

Number of virtual CPUs assigned to the sandbox.

integer

>= 1

memory_mib

required

Memory assigned to the sandbox, in MiB.

integer format: int64

>= 1

disk_mib

required

Writable disk size assigned to the sandbox, in MiB.

integer format: int64

>= 1

state

required

Current state of the sandbox.

string

Allowed values: starting running snapshotting paused unpausing deleting deleted

auto_pause

required

Whether the sandbox is configured to auto-pause on timeout.

boolean

network_policy

Network egress policy for a sandbox. When omitted, defaults to allow-all.

object

mode

required

Policy mode. allow-all permits all egress, deny-all blocks all egress, custom uses the allow/deny lists.

string

Allowed values: allow-all deny-all custom

allow_domains

Domain names to allow outbound access to (custom mode only).

Array<string>

<= 50 items

allow_cidrs

CIDR ranges to allow outbound access to (custom mode only).

Array<string>

<= 10 items

transforms

Per-domain request transforms, such as credential brokering.

Array<object>

<= 20 items

A per-domain request transform rule for credential brokering or header manipulation.

object

domain

required

Domain pattern to match (e.g. api.openai.com).

string

inject_headers

Headers to inject into matching requests.

object

key

additional properties

string

strip_headers

Header names to strip from matching requests.

Array<string>

created_at

required

ISO 8601 timestamp of when the sandbox was created.

string format: date-time

401

Unauthorized – invalid or missing API key.

object

message

required

Human-readable error message.

string

404

Resource not found.

object

message

required

Human-readable error message.

string

409

Conflict - sandbox is not running.

object

message

required

Human-readable error message.

string