Skip to main content
Saves a running API Box’s service and current state as an API Box Snapshot, ready when the response returns. The API Box keeps running, and a paused one is woken. API Boxes created from the Snapshot start with the saved state instead of a new workspace, so they refuse include_sample_data. The Snapshot outlives the API Box. A starting API Box returns 409 apibox_starting; a stopping or stopped one returns 409 apibox_stopped; one whose runtime cannot save its state returns 409 apibox_rebuild_required.
Alias: sas

​
Examples

Replace <id> with the resource ID from your response before you run the command.

​
Flags

​
string
Request body as JSON (alternative to individual flags). Can also be provided via stdin.
​
string
required
ID of the Box to save.
​
string
Optional key for retrying this save safely. A retry with the same key and request returns the Snapshot the first save created. The same key with a different request returns 409 idempotency_conflict.
​
string
Customer JSON metadata, up to 16 KiB and 64 nesting levels.
​
string
Name for the Snapshot. Omission generates a name.
Global flags apply to every command. See Global flags.