Restore Sandbox

curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/restore \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.declaw.ai/sandboxes/{sandbox_id}/restore"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/restore', 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://api.declaw.ai/sandboxes/{sandbox_id}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://api.declaw.ai/sandboxes/{sandbox_id}/restore"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.declaw.ai/sandboxes/{sandbox_id}/restore")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.declaw.ai/sandboxes/{sandbox_id}/restore")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

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

POST

sandboxes

{sandbox_id}

restore

Restore Sandbox

curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/restore \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.declaw.ai/sandboxes/{sandbox_id}/restore"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/restore', 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://api.declaw.ai/sandboxes/{sandbox_id}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://api.declaw.ai/sandboxes/{sandbox_id}/restore"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.declaw.ai/sandboxes/{sandbox_id}/restore")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.declaw.ai/sandboxes/{sandbox_id}/restore")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

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

Performs a cross-worker sandbox restore. Resolves the snapshot to restore from (either an explicitly named snapshot_id or the best available), picks an eligible orchestrator node — always excluding the originating node — forwards the restore to that orchestrator, and updates sandbox-manager state with the new node assignment. Unlike resume, restore works on sandboxes in any state as long as at least one snapshot exists, and always lands the sandbox on a fresh worker.

Path Parameters

string

required

The sandbox identifier. Format: sbx-<8 chars>.

Query Parameters

string

Optional specific snapshot to restore from. If omitted, the best available snapshot is selected (preference: pause → periodic → manual).

Response

Returns the orchestrator’s restore response (passed through), including the new guest_ip and envd_port for the restored VM.

Example

curl -X POST "https://api.declaw.ai/sandboxes/sbx-a1b2c3d4/restore?snapshot_id=snap-xyz" \
  -H "X-API-Key: YOUR_API_KEY"

from declaw import Sandbox

sbx = Sandbox.restore(
    "sbx-a1b2c3d4",
    snapshot_id="snap-xyz",
    api_key="YOUR_API_KEY",
    domain="api.declaw.ai",
)
sbx.commands.run("echo restored")

import { Sandbox } from "@declaw/sdk";

const sbx = await Sandbox.restore("sbx-a1b2c3d4", {
  snapshotId: "snap-xyz",
  apiKey: "YOUR_API_KEY",
  domain: "api.declaw.ai",
});

Error Responses

Status	Cause
`401`	Missing or invalid API key
`404`	Sandbox not found, or no snapshot available
`502`	Orchestrator unreachable or restore failed
`503`	No eligible orchestrator node available

List Snapshots Run Command

Sandbox API

Command API

Filesystem API

Volumes API

Restore Sandbox

Path Parameters

Query Parameters

Response

Example

Error Responses

​Path Parameters

​Query Parameters

​Response

​Example

​Error Responses

Path Parameters

Query Parameters

Response

Example

Error Responses