Skip to navigation
API ReferenceSandboxes

Get a sandbox snapshot

Beta
View as Markdown
Get a sandbox snapshot.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

sandboxIdstringRequired
snapshotIdstringRequired
Unique sandboxSnapshot identifier generated by BCTRL.

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
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
idstring
Unique sandboxSnapshot identifier generated by BCTRL.
imagestring
namestring or null
object"sandbox_snapshot"
sandboxIdstring or null

The sandbox it was taken from; null once that sandbox is deleted.

scheduledboolean
sizeBytesinteger or null>=0
spaceIdstring
Unique space identifier generated by BCTRL.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error