Update Web Box Snapshot
Renames a Web Box Snapshot or replaces its metadata. Omitted fields keep their current values. The built app does not change. Catalog Snapshots cannot be updated.
Authorizations
Use a Continuous API key. Send it in the Authorization header as a Bearer token.
Path Parameters
Web Box Snapshot ID.
^wbs_[0-9A-HJKMNP-TV-Z]{26}$Body
Response
OK
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.
What a ready Snapshot serves, or null.
Snapshot creation time.
Workspace credentials the build used: the Web App login, and any credentials it was allowed to call real systems with.
Why the build failed or was canceled, or null.
Limitations the Snapshot records beyond those listed in limitations.
x >= 0Web Box Snapshot ID.
^wbs_[0-9A-HJKMNP-TV-Z]{26}$The instructions the build followed, or empty when none were given.
Behavior the Snapshot does not serve like the real system, most important first, whether it was built or published. Empty when none.
Customer JSON metadata, or null.
Snapshot name. The ID is its identity, and names need not be unique.
128The build's research stage, or null when research did not run.
catalog for a Snapshot Continuous publishes, build for one built into the workspace.
catalog, build 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.
pending, building, ready, failed, canceled