Skip to navigation
API ReferenceSandboxes

Stop an sandbox

Beta
View as Markdown

Stop sandbox compute. Active processes are a conflict unless force is set. The disk stays on the host while stopped and is not replicated: if that host is lost, the sandbox fails with environment.host_lost and its files may be lost.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

sandboxIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

This endpoint expects an object.
forcebooleanOptionalDefaults to false
Cancel active executions before stopping. Without it, active work is a conflict.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
auditobject
browserIdstring or null
capabilitiesobject
Capabilities qualified for this sandbox. false means not available.
conversationIdstring or null
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
errorCodestring or null
idstring
Unique sandbox identifier generated by BCTRL.
imagestring
namestring or null
object"sandbox"
secretEnvobject or null

Secret substitution: references only, never values.

snapshotScheduleobject or null
spaceIdstring
Unique space identifier generated by BCTRL.
statusenum
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error