List sandboxes

GET

sandboxes

List sandboxes

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

import requests

url = "https://sandbox.brimble.io/sandboxes"

headers = {"x-brimble-key": "<api-key>"}

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

print(response.text)

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

fetch('https://sandbox.brimble.io/sandboxes', 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",
  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"

	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))

}

HttpResponse<String> response = Unirest.get("https://sandbox.brimble.io/sandboxes")
  .header("x-brimble-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.brimble.io/sandboxes")

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": "Sandboxes fetched",
  "data": {
    "data": [
      {
        "id": "<string>",
        "name": "<string>",
        "template": "<string>",
        "region": {
          "id": "6a06df21cc6bef51342e199e",
          "name": "eu-west",
          "country": "France",
          "continent": "Europe",
          "enabled": true,
          "type": "sandbox"
        },
        "specs": {
          "cpu": 1000,
          "memory": 1024,
          "disk": 3
        },
        "auto_destroy": true,
        "one_shot": true,
        "block_outbound": true,
        "egress": {
          "mode": "restricted",
          "allow": [
            "1.1.1.1",
            "api.example.com"
          ]
        },
        "persistent": true,
        "created_at": "2023-11-07T05:31:56Z",
        "last_activity_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "team": "<string>",
        "project_environment": "<string>",
        "network_updated": true,
        "persistent_disk_gb": 123,
        "paused_at": "2023-11-07T05:31:56Z",
        "from_snapshot": "<string>",
        "snapshot_frequency": "<string>",
        "destroyed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "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.

Query Parameters

page

integer

default:1

Required range: x >= 1

limit

integer

default:15

Required range: 1 <= x <= 100

Response

Paginated sandboxes

message

string

required

Example:

"Sandboxes fetched"

data

object

required

Show child attributes

Last modified on July 1, 2026

Create a sandboxProvisions a sandbox synchronously. The request blocks until the sandbox is `ready` (~2–3s typical). Returns **201** with `status: "ready"`. Use a client timeout of at least 90 seconds. On provisioning failure the API returns **503**. `GET /sandboxes/{id}/wait` remains for reconnect edge cases (e.g. after resume); it is not required after create. ## Network egress Control outbound network access at create time with the `egress` object, or the legacy `blockOutbound: true` shorthand (maps to `deny_all`). You cannot set both on the same request. | `egress.mode` | Behavior | |---|---| | `open` | Full outbound internet (default when omitted) | | `deny_all` | All outbound connections blocked | | `restricted` | Default deny + allowlist in `egress.allow` | Change policy later with `PUT /sandboxes/{id}/egress`.

List sandboxes

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

import requests

url = "https://sandbox.brimble.io/sandboxes"

headers = {"x-brimble-key": "<api-key>"}

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

print(response.text)

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

fetch('https://sandbox.brimble.io/sandboxes', 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",
  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"

	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))

}

HttpResponse<String> response = Unirest.get("https://sandbox.brimble.io/sandboxes")
  .header("x-brimble-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.brimble.io/sandboxes")

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": "Sandboxes fetched",
  "data": {
    "data": [
      {
        "id": "<string>",
        "name": "<string>",
        "template": "<string>",
        "region": {
          "id": "6a06df21cc6bef51342e199e",
          "name": "eu-west",
          "country": "France",
          "continent": "Europe",
          "enabled": true,
          "type": "sandbox"
        },
        "specs": {
          "cpu": 1000,
          "memory": 1024,
          "disk": 3
        },
        "auto_destroy": true,
        "one_shot": true,
        "block_outbound": true,
        "egress": {
          "mode": "restricted",
          "allow": [
            "1.1.1.1",
            "api.example.com"
          ]
        },
        "persistent": true,
        "created_at": "2023-11-07T05:31:56Z",
        "last_activity_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "team": "<string>",
        "project_environment": "<string>",
        "network_updated": true,
        "persistent_disk_gb": 123,
        "paused_at": "2023-11-07T05:31:56Z",
        "from_snapshot": "<string>",
        "snapshot_frequency": "<string>",
        "destroyed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "totalCount": 123,
    "currentPage": 123,
    "totalPages": 123,
    "limit": 123
  }
}

Discovery

Sandboxes

Runtime

Observability

Snapshots

Volumes

Sandboxes

Snapshots

Observability

Runtime

Volumes

Authorizations

Query Parameters

Response