Skip to main content
GET
Get Web 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

Web Box Snapshot ID.

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

Response

OK

build
object | null
required

The build's latest progress report, or null before the first report. A settled Snapshot keeps its last report. A build waiting for its live credentials resumes with POST /v1/webbox-snapshots/{id}/resume.

composition
object | null
required

What a ready Snapshot serves, or null.

created_at
string<date-time>
required

Snapshot creation time.

credential_ids
string[]
required

Workspace credentials the build used: the Web App login, and any credentials it was allowed to call real systems with.

error
object | null
required

Why the build failed or was canceled, or null.

hidden_limitations
integer<int64>
required

Limitations the Snapshot records beyond those listed in limitations.

Required range: x >= 0
id
string
required

Web Box Snapshot ID.

Pattern: ^wbs_[0-9A-HJKMNP-TV-Z]{26}$
instructions
string
required

The instructions the build followed, or empty when none were given.

limitations
object[]
required

Behavior the Snapshot does not serve like the real system, most important first, whether it was built or published. Empty when none.

metadata
any
required

Customer JSON metadata, or null.

name
string
required

Snapshot name. The ID is its identity, and names need not be unique.

Maximum string length: 128
research
object | null
required

The build's research stage, or null when research did not run.

source
enum<string>
required

catalog for a Snapshot Continuous publishes, build for one built into the workspace.

Available options:
catalog,
build
status
enum<string>
required

pending while waiting for capacity; building while the build runs; ready when Web Boxes can start from it; failed when the build failed; canceled when a cancel request took effect.

Available options:
pending,
building,
ready,
failed,
canceled