Snapshots
Create a snapshot
Triggers a snapshot of the sandbox’s current state. Sandbox must be ready.
Snapshot transitions through creating → ready (or failed); poll
GET /sandboxes/{id}/snapshots to see the new status.
POST
/
sandboxes
/
{id}
/
snapshots
Create a snapshot
curl --request POST \
--url https://sandbox.brimble.io/sandboxes/{id}/snapshots \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://sandbox.brimble.io/sandboxes/{id}/snapshots"
payload = { "name": "<string>" }
headers = {
"x-brimble-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://sandbox.brimble.io/sandboxes/{id}/snapshots', 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://sandbox.brimble.io/sandboxes/{id}/snapshots",
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([
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-brimble-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://sandbox.brimble.io/sandboxes/{id}/snapshots"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-brimble-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://sandbox.brimble.io/sandboxes/{id}/snapshots")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brimble.io/sandboxes/{id}/snapshots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Snapshot creation started",
"data": {
"id": "<string>",
"sandbox_id": "<string>",
"name": "<string>",
"image_tag": "<string>",
"source_template": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>",
"size_bytes": 123
}
}Authorizations
Your account-level Brimble API key. Find it in the dashboard under your profile drawer → API key (click the avatar in the sidebar). Available on paid plans only.
Path Parameters
24-char hex id of the sandbox.
Pattern:
^[a-f0-9]{24}$Body
application/json
Lowercase letters, digits, hyphens; 1–40 chars.
Pattern:
^[a-z0-9-]{1,40}$Last modified on May 20, 2026
Was this page helpful?
⌘I
Create a snapshot
curl --request POST \
--url https://sandbox.brimble.io/sandboxes/{id}/snapshots \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://sandbox.brimble.io/sandboxes/{id}/snapshots"
payload = { "name": "<string>" }
headers = {
"x-brimble-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://sandbox.brimble.io/sandboxes/{id}/snapshots', 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://sandbox.brimble.io/sandboxes/{id}/snapshots",
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([
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-brimble-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://sandbox.brimble.io/sandboxes/{id}/snapshots"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-brimble-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://sandbox.brimble.io/sandboxes/{id}/snapshots")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brimble.io/sandboxes/{id}/snapshots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Snapshot creation started",
"data": {
"id": "<string>",
"sandbox_id": "<string>",
"name": "<string>",
"image_tag": "<string>",
"source_template": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>",
"size_bytes": 123
}
}