Snapshots

Download a file or folder from a snapshot

Stream a single file’s bytes, or a folder subtree as a tar archive, directly out of a snapshot — the box can be stopped or archived; the machine is never contacted. Use GET /snapshots/{snapshotId}/tree to list paths, then pass one here. Paths are relative to the snapshot root (same space as tree entries; docker volumes under __dockervol__/). An empty or / path downloads the whole snapshot as a tar. Folder responses set X-Snapshot-File-Count, X-Snapshot-Total-Size-Bytes and X-Snapshot-Skipped-Base-Image-Files headers; both response shapes set X-Snapshot-Entry-Kind (file or dir).

GET

snapshots

{snapshotId}

files

Download a file or folder from a snapshot

curl --request GET \
  --url https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

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.

Query Parameters

path

string

File or folder path inside the snapshot. Empty for the whole snapshot.

Response

File bytes (application/octet-stream) or folder tar (application/x-tar).

The response is of type file.

Get snapshot downloadReturn 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.

Download a file or folder from a snapshot

curl --request GET \
  --url https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/snapshots/{snapshotId}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": true,
  "type": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}