Save a named snapshot
Freeze a box’s current state under a name (box snapshot <id> <name> in the CLI). Answers 202 immediately with the snapshot in saving; a running box takes a fresh capture first, which can run minutes. Poll GET /named-snapshots/{name} until the status settles at ready or failed. Reusing one of your existing names replaces that snapshot’s artifact once the new save is ready.
Authorizations
Box bearer token in the form box_.... Service API keys authenticate Box operations.
Body
The box whose current state to freeze.
Name to save under. 1-63 lowercase letters, digits, or dashes, starting with a letter or digit. Reusing one of your existing names replaces that snapshot's artifact. latest, tree, pull, rm, save, current, self, and new are reserved.
^[a-z0-9][a-z0-9-]{0,62}$Response
Save accepted and running in the background.
true
Stable success envelope discriminator added by v1.
"snapshot.named.saving""saving"A named snapshot: a frozen copy of a box's disk at one moment, saved under a name you pick. Independent of the source box's later life — the box can change, stop, or be deleted and the named snapshot still deploys. Named snapshots never expire; re-saving a name replaces its artifact.