Skip to main content
POST
Save a named snapshot

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Body

application/json
boxId
string
required

The box whose current state to freeze.

name
string
required

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.

Pattern: ^[a-z0-9][a-z0-9-]{0,62}$

Response

Save accepted and running in the background.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "snapshot.named.saving"
status
string
required
Allowed value: "saving"
snapshot
object
required

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.