Fork sandbox
curl --request POST \
--url https://api.e2b.app/sandboxes/{sandboxID}/fork \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"timeout": 15,
"count": 1
}
'import requests
url = "https://api.e2b.app/sandboxes/{sandboxID}/fork"
payload = {
"timeout": 15,
"count": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({timeout: 15, count: 1})
};
fetch('https://api.e2b.app/sandboxes/{sandboxID}/fork', 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.e2b.app/sandboxes/{sandboxID}/fork",
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([
'timeout' => 15,
'count' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.e2b.app/sandboxes/{sandboxID}/fork"
payload := strings.NewReader("{\n \"timeout\": 15,\n \"count\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.e2b.app/sandboxes/{sandboxID}/fork")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"timeout\": 15,\n \"count\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.e2b.app/sandboxes/{sandboxID}/fork")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"timeout\": 15,\n \"count\": 1\n}"
response = http.request(request)
puts response.read_body[
{
"sandbox": {
"templateID": "<string>",
"sandboxID": "<string>",
"clientID": "<string>",
"envdVersion": "<string>",
"alias": "<string>",
"envdAccessToken": "<string>",
"trafficAccessToken": "<string>",
"domain": "<string>"
},
"error": {
"code": 123,
"message": "<string>",
"error_code": "<string>"
}
}
]
Sandboxes
Fork sandbox
Fork the sandbox: checkpoint the running sandbox in place (it is briefly paused, snapshotted with its full memory state, and resumed on its node, keeping its ID and expiration untouched) and create count new sandboxes from that snapshot. Returns one result per requested fork, each carrying either the created sandbox or the error that prevented it from starting. A non-201 status means the request failed before any fork was attempted.
POST
/
sandboxes
/
{sandboxID}
/
fork
Fork sandbox
curl --request POST \
--url https://api.e2b.app/sandboxes/{sandboxID}/fork \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"timeout": 15,
"count": 1
}
'import requests
url = "https://api.e2b.app/sandboxes/{sandboxID}/fork"
payload = {
"timeout": 15,
"count": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({timeout: 15, count: 1})
};
fetch('https://api.e2b.app/sandboxes/{sandboxID}/fork', 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.e2b.app/sandboxes/{sandboxID}/fork",
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([
'timeout' => 15,
'count' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.e2b.app/sandboxes/{sandboxID}/fork"
payload := strings.NewReader("{\n \"timeout\": 15,\n \"count\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.e2b.app/sandboxes/{sandboxID}/fork")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"timeout\": 15,\n \"count\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.e2b.app/sandboxes/{sandboxID}/fork")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"timeout\": 15,\n \"count\": 1\n}"
response = http.request(request)
puts response.read_body[
{
"sandbox": {
"templateID": "<string>",
"sandboxID": "<string>",
"clientID": "<string>",
"envdVersion": "<string>",
"alias": "<string>",
"envdAccessToken": "<string>",
"trafficAccessToken": "<string>",
"domain": "<string>"
},
"error": {
"code": 123,
"message": "<string>",
"error_code": "<string>"
}
}
]
Body
application/json
Was this page helpful?