Skip to main content
GET
Get Cloud Box Snapshot

Authorizations

​
Authorization
string
header
required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Path Parameters

​
id
string
required

Snapshot ID.

Pattern: ^bxs_[0-9A-HJKMNP-TV-Z]{26}$

Response

OK

​
aliases
object
required

Short names for names in routes. Cloud Boxes started from the Snapshot resolve them.

​
cloudbox_id
string | null
required

ID of the Cloud Box a saved Snapshot captured, or null for the catalog and once that Cloud Box is deleted.

Pattern: ^box_[0-9A-HJKMNP-TV-Z]{26}$
​
created_at
string<date-time>
required

Snapshot creation time.

​
digest
string
required

Digest of the catalog image under the Snapshot.

Pattern: ^sha256:[0-9a-f]{64}$
​
id
string
required

Snapshot ID.

Pattern: ^bx[st]_[0-9A-HJKMNP-TV-Z]{26}$
​
name
string
required

Snapshot name, for example aws for the catalog's empty account.

Maximum string length: 128
​
resources_recorded_at
string<date-time> | null
required

When the resources inside the Cloud Box were recorded on the Snapshot, or null for the catalog and when they were not recorded.

​
routes
object[]
required

Names inside the Cloud Box when the Snapshot was saved; empty for the catalog and for Snapshots saved before names were recorded.

​
source
enum<string>
required

catalog for a Snapshot Continuous publishes, box for one saved from a Cloud Box.

Available options:
catalog,
box
​
status
enum<string>
required

creating while a save runs. A Cloud Box can start from a ready Snapshot. unavailable is a catalog Snapshot a newer revision replaced.

Available options:
creating,
ready,
failed,
unavailable
​
type
enum<string>
required

Platform the Snapshot emulates. Cloud Boxes and Keys take their Snapshot's type.

Available options:
aws