Box

Get snapshot download

Return time-limited signed URLs for every chunk needed to reconstruct the box filesystem at this snapshot (the full chain, base through this generation), plus the inventory. Download the chunks and reassemble them as described by reconstruct. The box snapshot pull CLI command does this for you.

get/snapshots/{snapshotId}/download

Request

Base URL
https://ascii.dev/api/box/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ascii/apis/box-public-api-v1/docs/snapshots/:snapshotId/download/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

snapshotIdstring uuid required

Snapshot id returned by the snapshot list/latest calls.

Response

Signed chunk URLs for the snapshot chain.

okboolean required

type'snapshot.download' required

Stable success envelope discriminator added by v1.

snapshotIdstring uuid required

boxIdstring required

kind'base' | 'incremental' | 'legacy' required

generationinteger required

expiresInSecondsinteger required

Lifetime of every signedUrl in this response.

reconstructstring required

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

Example response

{
  "ok": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.