List snapshots for a sandbox

GET

sandboxes

{id}

snapshots

curl --request GET \
  --url https://sandbox.brimble.io/sandboxes/{id}/snapshots \
  --header 'x-brimble-key: <api-key>'

const options = {method: 'GET', headers: {'x-brimble-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.brimble.io/sandboxes/{id}/snapshots"

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

	req.Header.Add("x-brimble-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-brimble-key"] = '<api-key>'

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

{
  "message": "Snapshots fetched",
  "data": {
    "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
      }
    ],
    "totalCount": 123,
    "currentPage": 123,
    "totalPages": 123,
    "limit": 123
  }
}

Authorizations

x-brimble-key

string

header

required

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

string

required

24-char hex id of the sandbox.

Pattern: ^[a-f0-9]{24}$

Query Parameters

page

integer

default:1

Required range: x >= 1

limit

integer

default:15

Required range: 1 <= x <= 100

Response

Paginated snapshots

message

string

required

Example:

"Snapshots fetched"

data

object

required

Show child attributes

Last modified on July 23, 2026

Create a snapshotTriggers 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.

List snapshots for a sandbox

curl --request GET \
  --url https://sandbox.brimble.io/sandboxes/{id}/snapshots \
  --header 'x-brimble-key: <api-key>'

const options = {method: 'GET', headers: {'x-brimble-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.brimble.io/sandboxes/{id}/snapshots"

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

	req.Header.Add("x-brimble-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["x-brimble-key"] = '<api-key>'

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

{
  "message": "Snapshots fetched",
  "data": {
    "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
      }
    ],
    "totalCount": 123,
    "currentPage": 123,
    "totalPages": 123,
    "limit": 123
  }
}

Discovery

Sandboxes

Runtime

Observability

Snapshots

Volumes

Sandboxes

Snapshots

Observability

Runtime

Volumes

List snapshots for a sandbox

Authorizations

Path Parameters

Query Parameters

Response