Cancel Web Box Snapshot build
Requests cancellation of a pending or active build and returns the Snapshot without waiting for the build to stop. Get the Snapshot until its status leaves pending or building. The build can finish before cancellation takes effect. A Snapshot whose build has settled is returned unchanged.
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}$Response
Accepted
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 when the Snapshot's resume is requested.
What a ready Snapshot serves, or null.
Snapshot creation time.
Workspace credentials the build used, such as a web app login or credentials it was allowed to call real systems with. Empty when none.
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. 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 boxes can start from it; failed when the build failed; canceled when a cancel request took effect.
pending, building, ready, failed, canceled