Skip to main content
GET
Get snapshot file tree

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

Flat file/folder listing for the snapshot.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "snapshot.tree"
snapshotId
string<uuid>
required
boxId
string
required
generation
integer
required
treeAvailable
boolean
required

false for legacy snapshots or inventories too large to expand; see reason.

truncated
boolean
required

true when the file list was capped; not every entry is returned.

fileCount
integer
required

Number of your files in this snapshot (base-image system files excluded).

totalSizeBytes
integer
required

Total bytes of your data in this snapshot (base-image system files excluded).

entries
object[]
required

Exactly the files/dirs a resume or download returns, your data only; base-image system entries are not listed.

reason
string

Why the tree is unavailable, when treeAvailable is false.

Examples:

"legacy_snapshot"

"inventory_too_large"