Skip to main content
GET
/
snapshots
/
{snapshotId}
/
download
Get snapshot download
curl --request GET \
  --url https://ascii.dev/api/box/v1/snapshots/{snapshotId}/download \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "type": "snapshot.download",
  "snapshotId": "7417be09-d419-4ae0-b3fc-7f04a5a71ef1",
  "boxId": "bx_23456789",
  "kind": "incremental",
  "generation": 3,
  "expiresInSeconds": 3600,
  "reconstruct": "Download every chunk. For each snapshot in ascending generation, concat its chunks by chunkIndex and pipe through `zstd -d | tar -x`.",
  "inventory": {
    "r2Key": "chains/4ced5b04/inventory-3.json.zst",
    "signedUrl": "https://r2.example/chains/4ced5b04/inventory-3.json.zst?sig=redacted"
  },
  "chunks": [
    {
      "snapshotId": "2db50582-716c-424c-817e-9495484f88dd",
      "generation": 0,
      "chunkIndex": 0,
      "r2Key": "chains/4ced5b04/snapshots/2db50582/chunks/00.tar.zst",
      "sizeBytes": 209715200,
      "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "signedUrl": "https://r2.example/chains/4ced5b04/snapshots/2db50582/chunks/00.tar.zst?sig=redacted"
    }
  ]
}

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