Export the filesystem changes to a presigned URL

curl --request POST \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "async": false,
  "dryRun": false,
  "excludes": [
    "<string>"
  ],
  "headers": {},
  "imageDevice": "/dev/vda",
  "imageMountPoint": "/mnt/lower",
  "multipart": {
    "abortUrl": "<string>",
    "completeUrl": "<string>",
    "partSize": 536870912,
    "partUrls": [
      "<string>"
    ]
  },
  "saveProcesses": true,
  "stopTimeoutSeconds": 30,
  "url": "https://bucket.s3.amazonaws.com/key?..."
}
'

import requests

url = "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export"

payload = {
    "async": False,
    "dryRun": False,
    "excludes": ["<string>"],
    "headers": {},
    "imageDevice": "/dev/vda",
    "imageMountPoint": "/mnt/lower",
    "multipart": {
        "abortUrl": "<string>",
        "completeUrl": "<string>",
        "partSize": 536870912,
        "partUrls": ["<string>"]
    },
    "saveProcesses": True,
    "stopTimeoutSeconds": 30,
    "url": "https://bucket.s3.amazonaws.com/key?..."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    async: false,
    dryRun: false,
    excludes: ['<string>'],
    headers: {},
    imageDevice: '/dev/vda',
    imageMountPoint: '/mnt/lower',
    multipart: {
      abortUrl: '<string>',
      completeUrl: '<string>',
      partSize: 536870912,
      partUrls: ['<string>']
    },
    saveProcesses: true,
    stopTimeoutSeconds: 30,
    url: 'https://bucket.s3.amazonaws.com/key?...'
  })
};

fetch('https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export', 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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'async' => false,
    'dryRun' => false,
    'excludes' => [
        '<string>'
    ],
    'headers' => [
        
    ],
    'imageDevice' => '/dev/vda',
    'imageMountPoint' => '/mnt/lower',
    'multipart' => [
        'abortUrl' => '<string>',
        'completeUrl' => '<string>',
        'partSize' => 536870912,
        'partUrls' => [
                '<string>'
        ]
    ],
    'saveProcesses' => true,
    'stopTimeoutSeconds' => 30,
    'url' => 'https://bucket.s3.amazonaws.com/key?...'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export"

	payload := strings.NewReader("{\n  \"async\": false,\n  \"dryRun\": false,\n  \"excludes\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"imageDevice\": \"/dev/vda\",\n  \"imageMountPoint\": \"/mnt/lower\",\n  \"multipart\": {\n    \"abortUrl\": \"<string>\",\n    \"completeUrl\": \"<string>\",\n    \"partSize\": 536870912,\n    \"partUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"saveProcesses\": true,\n  \"stopTimeoutSeconds\": 30,\n  \"url\": \"https://bucket.s3.amazonaws.com/key?...\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"async\": false,\n  \"dryRun\": false,\n  \"excludes\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"imageDevice\": \"/dev/vda\",\n  \"imageMountPoint\": \"/mnt/lower\",\n  \"multipart\": {\n    \"abortUrl\": \"<string>\",\n    \"completeUrl\": \"<string>\",\n    \"partSize\": 536870912,\n    \"partUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"saveProcesses\": true,\n  \"stopTimeoutSeconds\": 30,\n  \"url\": \"https://bucket.s3.amazonaws.com/key?...\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"async\": false,\n  \"dryRun\": false,\n  \"excludes\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"imageDevice\": \"/dev/vda\",\n  \"imageMountPoint\": \"/mnt/lower\",\n  \"multipart\": {\n    \"abortUrl\": \"<string>\",\n    \"completeUrl\": \"<string>\",\n    \"partSize\": 536870912,\n    \"partUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"saveProcesses\": true,\n  \"stopTimeoutSeconds\": 30,\n  \"url\": \"https://bucket.s3.amazonaws.com/key?...\"\n}"

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

{
  "manifest": {
    "createdAt": "<string>",
    "root": "/",
    "version": 1,
    "added": 11,
    "apiVersion": "v0.1.0",
    "deleted": [
      "<string>"
    ],
    "excludes": [
      "<string>"
    ],
    "imageDevice": "/dev/vda",
    "modified": 3,
    "payloadBytes": 3073449,
    "processes": true
  },
  "changes": [
    {
      "kind": "added",
      "path": "usr/bin/curl",
      "size": 256216
    }
  ],
  "duration": "4.2s",
  "size": 3074211,
  "stoppedProcesses": [
    "<string>"
  ],
  "uploaded": true
}

{
  "error": "<string>",
  "finishedAt": "<string>",
  "size": 3074211,
  "startedAt": "<string>",
  "state": "running",
  "uploaded": false
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

Export the filesystem changes to a presigned URL

Archives everything the sandbox changed on top of its base image and streams it, uncompressed, to a presigned S3 PUT URL. The memory of the sandbox is not archived. The sandbox is quiesced first: the process list is saved (unless saveProcesses is false), every process is stopped, and the API then refuses the calls that would write to the filesystem. The freeze is not lifted afterwards, since an exported sandbox is meant to be restored elsewhere; call POST /archive/resume to lift it. Use dryRun to get the archive’s content and exact size without stopping anything and without uploading. Set async to start the export and answer immediately, which is what archiving a large filesystem needs: the export then reports itself through GET /archive/status.

POST

archive

export

curl --request POST \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "async": false,
  "dryRun": false,
  "excludes": [
    "<string>"
  ],
  "headers": {},
  "imageDevice": "/dev/vda",
  "imageMountPoint": "/mnt/lower",
  "multipart": {
    "abortUrl": "<string>",
    "completeUrl": "<string>",
    "partSize": 536870912,
    "partUrls": [
      "<string>"
    ]
  },
  "saveProcesses": true,
  "stopTimeoutSeconds": 30,
  "url": "https://bucket.s3.amazonaws.com/key?..."
}
'

import requests

url = "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export"

payload = {
    "async": False,
    "dryRun": False,
    "excludes": ["<string>"],
    "headers": {},
    "imageDevice": "/dev/vda",
    "imageMountPoint": "/mnt/lower",
    "multipart": {
        "abortUrl": "<string>",
        "completeUrl": "<string>",
        "partSize": 536870912,
        "partUrls": ["<string>"]
    },
    "saveProcesses": True,
    "stopTimeoutSeconds": 30,
    "url": "https://bucket.s3.amazonaws.com/key?..."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    async: false,
    dryRun: false,
    excludes: ['<string>'],
    headers: {},
    imageDevice: '/dev/vda',
    imageMountPoint: '/mnt/lower',
    multipart: {
      abortUrl: '<string>',
      completeUrl: '<string>',
      partSize: 536870912,
      partUrls: ['<string>']
    },
    saveProcesses: true,
    stopTimeoutSeconds: 30,
    url: 'https://bucket.s3.amazonaws.com/key?...'
  })
};

fetch('https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export', 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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'async' => false,
    'dryRun' => false,
    'excludes' => [
        '<string>'
    ],
    'headers' => [
        
    ],
    'imageDevice' => '/dev/vda',
    'imageMountPoint' => '/mnt/lower',
    'multipart' => [
        'abortUrl' => '<string>',
        'completeUrl' => '<string>',
        'partSize' => 536870912,
        'partUrls' => [
                '<string>'
        ]
    ],
    'saveProcesses' => true,
    'stopTimeoutSeconds' => 30,
    'url' => 'https://bucket.s3.amazonaws.com/key?...'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export"

	payload := strings.NewReader("{\n  \"async\": false,\n  \"dryRun\": false,\n  \"excludes\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"imageDevice\": \"/dev/vda\",\n  \"imageMountPoint\": \"/mnt/lower\",\n  \"multipart\": {\n    \"abortUrl\": \"<string>\",\n    \"completeUrl\": \"<string>\",\n    \"partSize\": 536870912,\n    \"partUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"saveProcesses\": true,\n  \"stopTimeoutSeconds\": 30,\n  \"url\": \"https://bucket.s3.amazonaws.com/key?...\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"async\": false,\n  \"dryRun\": false,\n  \"excludes\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"imageDevice\": \"/dev/vda\",\n  \"imageMountPoint\": \"/mnt/lower\",\n  \"multipart\": {\n    \"abortUrl\": \"<string>\",\n    \"completeUrl\": \"<string>\",\n    \"partSize\": 536870912,\n    \"partUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"saveProcesses\": true,\n  \"stopTimeoutSeconds\": 30,\n  \"url\": \"https://bucket.s3.amazonaws.com/key?...\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/archive/export")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"async\": false,\n  \"dryRun\": false,\n  \"excludes\": [\n    \"<string>\"\n  ],\n  \"headers\": {},\n  \"imageDevice\": \"/dev/vda\",\n  \"imageMountPoint\": \"/mnt/lower\",\n  \"multipart\": {\n    \"abortUrl\": \"<string>\",\n    \"completeUrl\": \"<string>\",\n    \"partSize\": 536870912,\n    \"partUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"saveProcesses\": true,\n  \"stopTimeoutSeconds\": 30,\n  \"url\": \"https://bucket.s3.amazonaws.com/key?...\"\n}"

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

{
  "manifest": {
    "createdAt": "<string>",
    "root": "/",
    "version": 1,
    "added": 11,
    "apiVersion": "v0.1.0",
    "deleted": [
      "<string>"
    ],
    "excludes": [
      "<string>"
    ],
    "imageDevice": "/dev/vda",
    "modified": 3,
    "payloadBytes": 3073449,
    "processes": true
  },
  "changes": [
    {
      "kind": "added",
      "path": "usr/bin/curl",
      "size": 256216
    }
  ],
  "duration": "4.2s",
  "size": 3074211,
  "stoppedProcesses": [
    "<string>"
  ],
  "uploaded": true
}

{
  "error": "<string>",
  "finishedAt": "<string>",
  "size": 3074211,
  "startedAt": "<string>",
  "state": "running",
  "uploaded": false
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Export options

async

boolean

Async starts the export and answers immediately, leaving it to run: an archive of a large filesystem takes longer than a request may be held open. Its progress is reported by /archive/status.

Example:

false

dryRun

boolean

DryRun reports what would be archived, and its exact size, without stopping anything and without uploading.

Example:

false

excludes

string[]

Excludes are added to the paths excluded by default.

headers

object

Headers are sent with the upload request as given. A presigned URL only accepts the headers it was signed for, so these have to match what the caller signed: sending one that was not signed, or signing one that is not sent, is rejected as a signature mismatch. Typical use is a storage class, x-amz-storage-class: GLACIER_IR.

Show child attributes

imageDevice

string

ImageDevice is the device holding the pristine image, /dev/vda by default. A generation that attaches the image elsewhere names its device here.

Example:

"/dev/vda"

imageMountPoint

string

ImageMountPoint is a directory where the pristine image is already mounted. When set the image device is neither mounted nor unmounted.

Example:

"/mnt/lower"

multipart

object

Multipart uploads the archive part by part instead, which is how an archive larger than the 5 GB a single PUT accepts is stored. It takes precedence over URL.

Show child attributes

saveProcesses

boolean

SaveProcesses stores the process list in the archive so restore can relaunch the workload. Defaults to true; set it to false to archive storage only.

Example:

true

stopTimeoutSeconds

integer

StopTimeoutSeconds bounds the graceful stop of each process.

Example:

30

url

string

URL is a presigned S3 PUT URL the archive is streamed to. Empty is only valid with DryRun, or with Multipart.

Example:

"https://bucket.s3.amazonaws.com/key?..."

Response

Export result

manifest

object

required

Show child attributes

changes

object[]

Changes lists every path in the archive. Only filled for a dry run, where it is the point of the call.

Show child attributes

duration

string

Example:

"4.2s"

size

integer

Size is the exact number of bytes uploaded, known before the upload starts since the archive is not compressed.

Example:

3074211

stoppedProcesses

string[]

StoppedProcesses are the processes stopped to freeze the filesystem.

uploaded

boolean

Uploaded is false for a dry run.

Example:

true

Last modified on August 26, 2026

⌘I

archive

fastapply

codegen

drive

system

filesystem

network

process

Export the filesystem changes to a presigned URL

Authorizations

Body

Response