Pause a sandbox

Freezes the sandbox's vCPUs and keeps its memory and disk on the node. A paused sandbox bills no CPU time and still counts allocated memory; it still expires at `expires_at`. Resume continues exactly where it stopped. Pausing a paused sandbox returns it unchanged.

POST /v1/sandboxes/{sandbox_id}/pause

Authentication

Bearer Token (b3os_sk_ API key or b3os_pat_ token) API Key (cookie: __Host-b3os_session)

Path Parameters

sandbox_id string required path

The sandbox ID (`sbx_…`).

Example: "sbx_01m5t68q1b590rj801nbzsqzkk"

Responses

200 The paused sandbox.

application/json

id string REQUIRED

object string REQUIRED

Enum: sandbox

status string REQUIRED

`running` → `paused` ↔ `running` → `stopped`. `failed` means the microVM crashed; its usage is final.

Enum: running, paused, stopped, failed

host_id string REQUIRED

The ID in host-safe form, used in port URLs.

template object REQUIRED

id string REQUIRED

name string REQUIRED

snapshot string | null REQUIRED

The snapshot the sandbox was restored from.

vcpu integer REQUIRED

memory_mib integer REQUIRED

disk_gib integer REQUIRED

timeout_s integer REQUIRED

on_idle string REQUIRED

Enum: stop, pause

expires_at string (date-time) REQUIRED

env object REQUIRED

secret_names string[] REQUIRED

Names of the variables set from `secrets` (values are never returned).

Array of: string

ports object[] REQUIRED

Array of:

port integer REQUIRED

public boolean REQUIRED

url string (uri) | null REQUIRED

Public ports: the long-lived preview URL, token included. Private ports: `null`; mint a URL with `POST /v1/sandboxes/{sandbox_id}/ports/{port}/url`.

api object REQUIRED

scopes string[] REQUIRED

Array of: string

spend_cap_usd number | null REQUIRED

The grant's own cap, or `null` when the creating principal's cap applies.

connections string[] REQUIRED

Array of: string

egress object REQUIRED

mode string REQUIRED

Enum: public, allowlist, deny

allow string[] REQUIRED

Array of: string

forkable boolean REQUIRED

created_at string (date-time) REQUIRED

started_at string (date-time) REQUIRED

paused_at string (date-time) | null REQUIRED

stopped_at string (date-time) | null REQUIRED

stop_reason string | null REQUIRED

Why the sandbox stopped.

Enum: deleted, timeout, failed, null

usage object REQUIRED

vcpu_ms integer REQUIRED

gib_ms integer REQUIRED

timing object

Server-side phase durations in milliseconds with microsecond resolution: the same phases as the `Server-Timing` header, keyed `<phase>_ms`. `total_ms` is always present. Phase names are product-specific and documented per operation. Example values in this reference are illustrative, not measurements.

total_ms number REQUIRED

metadata object REQUIRED

Up to 16 string key-value pairs you attach to an object for your own use. Keys are 1 to 40 characters of `A-Z a-z 0-9 _ . : -`; values are at most 500 characters. B3OS never interprets them.

400 The request failed validation (`invalid_request`, `invalid_url`).

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

401 Missing, malformed, expired or revoked credentials (`unauthorized`).

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

403 Authenticated but not allowed (`forbidden`, `egress_denied`).

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

404 No such sandbox in this project (`sandbox_not_found`).

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

409 The sandbox is paused or stopped (`sandbox_not_running`).

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

429 A rate, concurrency or quota limit applies (`rate_limited`, `concurrency_limited`, `quota_exceeded`).

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

500 Something failed inside B3OS (`internal`). Retry with backoff.

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

503 The node or the product is not available right now (`node_unavailable`, `product_unavailable`, `capacity_unavailable`).

application/problem+json

type string (uri) REQUIRED

`https://docs.beta.b3os.org/errors#<code>`.

title string REQUIRED

Short summary of the problem type.

status integer REQUIRED

The HTTP status code, repeated for convenience.

code string REQUIRED

Stable machine-readable error code from the errors catalog.

detail string REQUIRED

Explanation of this occurrence. Never contains secrets.

instance string

The request ID (`req_…`) of the request that failed. Include it when you contact support.

errors object[]

Validation problems, one per field (`invalid_request` and the other codes that list `errors`).

Array of:

pointer string REQUIRED

Where the problem is: a JSON pointer into the request body (`/url`, `/steps/0/uses`), or `#query/<name>`, `#path/<name>` or `#header/<name>` for parameters.

detail string REQUIRED

What is wrong there.

reason string

Finer-grained cause for codes that document one (`unauthorized`, `forbidden`, `egress_denied`, `upstream_unreachable`, …).

required_scope string

The scope that was missing (`forbidden` with `reason: scope`).

retry_after_s integer

Same value as the `Retry-After` header, for clients that only read the body.

limit object

The limit an error refers to. IDs and current values are listed by `GET /v1/limits`.

id string REQUIRED

Limit ID, such as `vision.scrape.rpm` or `sandboxes.concurrent`.

limit number REQUIRED

The limit's value.

unit string REQUIRED

What the limit counts, such as `requests`, `sandboxes`, `vcpu` or `MiB`.

window_s integer

Window length in seconds for rate limits and quotas.

current number

Current usage against the limit, when known.

current_status string

The object's current status, for state conflicts such as `sandbox_not_running`.

upstream_status integer

The HTTP status the upstream returned (`upstream_error`, `action_output_invalid`).

step string

The failed step, as a step ID (routines), an index (`act`) or a path such as `beats/2/do/0` (render).

pack_error object

The error a pack's error mapping chose (`upstream_error` from pack actions).

code string REQUIRED

message string REQUIRED

retryable boolean REQUIRED

curl -X POST 'https://beta-api.b3os.org/v1/sandboxes/sbx_01m5t68q1b590rj801nbzsqzkk/pause' \  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://beta-api.b3os.org/v1/sandboxes/sbx_01m5t68q1b590rj801nbzsqzkk/pause', {  method: 'POST',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN"  }});const data = await response.json();console.log(data);

import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.post('https://beta-api.b3os.org/v1/sandboxes/sbx_01m5t68q1b590rj801nbzsqzkk/pause', headers=headers)print(response.json())

200 Response

{  "id": "sbx_01m5t68q1b590rj801nbzsqzkk",  "object": "sandbox",  "status": "paused",  "host_id": "sbx-01m5t68q1b590rj801nbzsqzkk",  "template": {    "id": "tpl_01m5t59b2ps0djyzdf082s18bz",    "name": "base"  },  "snapshot": null,  "vcpu": 2,  "memory_mib": 2048,  "disk_gib": 4,  "timeout_s": 900,  "on_idle": "stop",  "expires_at": "2026-10-25T19:15:00.004Z",  "env": {},  "secret_names": [],  "ports": [],  "api": {    "scopes": [],    "spend_cap_usd": null,    "connections": []  },  "egress": {    "mode": "public",    "allow": []  },  "forkable": false,  "created_at": "2026-10-25T19:00:00.000Z",  "started_at": "2026-10-25T19:00:00.004Z",  "paused_at": "2026-10-25T19:02:00.000Z",  "stopped_at": null,  "stop_reason": null,  "usage": {    "vcpu_ms": 2100,    "gib_ms": 245760  },  "timing": {    "pause_ms": 0.4,    "total_ms": 0.6  },  "metadata": {}}

400 Response

{  "type": "https://docs.beta.b3os.org/errors#invalid_request",  "title": "Invalid request",  "status": 400,  "code": "invalid_request",  "detail": "1 field failed validation",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "errors": [    {      "pointer": "/url",      "detail": "must be an absolute http or https URL"    }  ]}

401 Response

{  "type": "https://docs.beta.b3os.org/errors#unauthorized",  "title": "Unauthorized",  "status": 401,  "code": "unauthorized",  "detail": "API key checksum does not match; check that the whole key was copied",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "reason": "malformed"}

403 Response

{  "type": "https://docs.beta.b3os.org/errors#forbidden",  "title": "Forbidden",  "status": 403,  "code": "forbidden",  "detail": "This key lacks the scope sandboxes:write",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "reason": "scope",  "required_scope": "sandboxes:write"}

404 Response

{  "type": "https://docs.beta.b3os.org/errors#sandbox_not_found",  "title": "Sandbox not found",  "status": 404,  "code": "sandbox_not_found",  "detail": "No sandbox sbx_01m5t68q1b590rj801nbzsqzkk in this project",  "instance": "req_01m5t4yg394wegr3j4y01qb363"}

409 Response

{  "type": "https://docs.beta.b3os.org/errors#sandbox_not_running",  "title": "Sandbox not running",  "status": 409,  "code": "sandbox_not_running",  "detail": "sbx_01m5t68q1b590rj801nbzsqzkk is paused; resume it first",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "current_status": "paused"}

429 Response

{  "type": "https://docs.beta.b3os.org/errors#rate_limited",  "title": "Rate limited",  "status": 429,  "code": "rate_limited",  "detail": "60 scrapes per minute allowed; retry in 12 seconds",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "retry_after_s": 12,  "limit": {    "id": "vision.scrape.rpm",    "limit": 60,    "unit": "requests",    "window_s": 60,    "current": 60  }}

500 Response

{  "type": "https://docs.beta.b3os.org/errors#internal",  "title": "Internal error",  "status": 500,  "code": "internal",  "detail": "internal error",  "instance": "req_01m5t4yg394wegr3j4y01qb363"}

503 Response

{  "type": "https://docs.beta.b3os.org/errors#node_unavailable",  "title": "Node unavailable",  "status": 503,  "code": "node_unavailable",  "detail": "Node n1 is not reachable; retry in 5 seconds",  "instance": "req_01m5t4yg394wegr3j4y01qb363",  "retry_after_s": 5}

POST /v1/sandboxes/{sandbox_id}/pause

Base URL

Bearer Token

Path Parameters

sandbox_id string required

Response

Was this page helpful?

Previous Extend a sandbox's timeout

Next Resume a sandbox