Skip to navigation
API ReferenceSandboxes

Get an sandbox

Beta
View as Markdown
Get one sandbox with its status and qualified capabilities.

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.

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