Skip to main content
POST
Resume sandbox

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

sandboxId
string
required

Public Sandbox id returned by create/list/get sandbox calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json

Options for resuming a stopped sandbox.

type
enum<string>

Resume onto a different machine size. Omit to keep the sandbox's current type. A resume already restores onto a fresh machine, so changing size costs nothing extra. Shrinking is rejected with type_too_small when the sandbox's data would not fit the smaller disk. xlarge requires the effective $100 plan or higher and an explicit bare-metal operator allocation.

Available options:
small,
default,
large,
xlarge
env
object

Replaces the sandbox's per-sandbox environment variables. Omit to keep the sandbox's current env. Same validation rules as CreateSandboxRequest.env.

environment
string

Optionally re-pin the sandbox to a different named sandbox environment on resume. Omit to keep the sandbox's current environment. Unknown names are rejected with unknown_environment.

Examples:

"base"

"customer-demos"

noEnv
boolean

Resume into a no-env sandbox: withhold account secrets and scrub inherited owner secrets from the restored snapshot before the sandbox is exposed. One-way; once a sandbox is resumed as no-env it stays no-env on later resumes.

ttlSeconds
integer | null

Auto-stop for the resumed sandbox, in seconds, stored on the sandbox. Omit to keep the TTL the sandbox already had. null disables auto-stop, which means nothing will ever stop this sandbox for you.

Required range: 1 <= x <= 2592000

Response

Resume started.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Example:

"sandbox.stopping"

id
string
required
status
string
required
Example:

"archiving"

sandbox
object | null