Skip to main content
GET
Get snapshot download

Authorizations

Authorization
string
header
required

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

Path Parameters

snapshotId
string<uuid>
required

Snapshot id returned by the snapshot list/latest calls.

Response

Signed chunk URLs for the snapshot chain.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "snapshot.download"
snapshotId
string<uuid>
required
boxId
string
required
kind
enum<string>
required
Available options:
base,
incremental,
legacy
generation
integer
required
expiresInSeconds
integer
required

Lifetime of every signedUrl in this response.

reconstruct
string
required

Human-readable note on how to reassemble the chunks into a filesystem.

chunks
object[]
required

Every chunk across the chain (all generations up to and including this snapshot), ordered by (generation, chunkIndex).

inventory
object | null