Sign in

v1

latestOpenAPI 3.1.02026-07-22304756.7 KB
Box

Get snapshot file tree

List the files and folders captured in a snapshot, with sizes. Returns a flat list of entries you can render as a tree.

get/snapshots/{snapshotId}/tree

Path parameters

snapshotIdstring uuid required

Snapshot id returned by the snapshot list/latest calls.

Response

Flat file/folder listing for the snapshot.

okboolean required
type'snapshot.tree' required

Stable success envelope discriminator added by v1.

snapshotIdstring uuid required
boxIdstring required
generationinteger required
treeAvailableboolean required

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

truncatedboolean required

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

fileCountinteger required

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

totalSizeBytesinteger required

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

reasonstring

Why the tree is unavailable, when treeAvailable is false.

Example response

{
  "ok": true,
  "reason": "legacy_snapshot"
}