Create a sandbox

curl --request POST \
  --url https://api.brimble.io/core/v1/sandboxes \
  --header 'Content-Type: application/json' \
  --header 'x-brimble-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "template": "<string>",
  "teamId": "<string>",
  "environmentId": "<string>",
  "region": "<string>",
  "size": "<string>",
  "autoDestroy": true,
  "oneShot": true,
  "blockOutbound": true,
  "egress": {
    "allow": [
      "<string>"
    ]
  },
  "persistent": true,
  "persistentDiskGB": 123,
  "volumeId": "<string>",
  "mountPath": "<string>",
  "fromSnapshot": "<string>",
  "snapshotFrequency": "<string>"
}
'

import requests

url = "https://api.brimble.io/core/v1/sandboxes"

payload = {
    "name": "<string>",
    "template": "<string>",
    "teamId": "<string>",
    "environmentId": "<string>",
    "region": "<string>",
    "size": "<string>",
    "autoDestroy": True,
    "oneShot": True,
    "blockOutbound": True,
    "egress": { "allow": ["<string>"] },
    "persistent": True,
    "persistentDiskGB": 123,
    "volumeId": "<string>",
    "mountPath": "<string>",
    "fromSnapshot": "<string>",
    "snapshotFrequency": "<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>',
    template: '<string>',
    teamId: '<string>',
    environmentId: '<string>',
    region: '<string>',
    size: '<string>',
    autoDestroy: true,
    oneShot: true,
    blockOutbound: true,
    egress: {allow: ['<string>']},
    persistent: true,
    persistentDiskGB: 123,
    volumeId: '<string>',
    mountPath: '<string>',
    fromSnapshot: '<string>',
    snapshotFrequency: '<string>'
  })
};

fetch('https://api.brimble.io/core/v1/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://api.brimble.io/core/v1/sandboxes",
  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>',
    'template' => '<string>',
    'teamId' => '<string>',
    'environmentId' => '<string>',
    'region' => '<string>',
    'size' => '<string>',
    'autoDestroy' => true,
    'oneShot' => true,
    'blockOutbound' => true,
    'egress' => [
        'allow' => [
                '<string>'
        ]
    ],
    'persistent' => true,
    'persistentDiskGB' => 123,
    'volumeId' => '<string>',
    'mountPath' => '<string>',
    'fromSnapshot' => '<string>',
    'snapshotFrequency' => '<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://api.brimble.io/core/v1/sandboxes"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"template\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"environmentId\": \"<string>\",\n  \"region\": \"<string>\",\n  \"size\": \"<string>\",\n  \"autoDestroy\": true,\n  \"oneShot\": true,\n  \"blockOutbound\": true,\n  \"egress\": {\n    \"allow\": [\n      \"<string>\"\n    ]\n  },\n  \"persistent\": true,\n  \"persistentDiskGB\": 123,\n  \"volumeId\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"fromSnapshot\": \"<string>\",\n  \"snapshotFrequency\": \"<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://api.brimble.io/core/v1/sandboxes")
  .header("x-brimble-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"template\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"environmentId\": \"<string>\",\n  \"region\": \"<string>\",\n  \"size\": \"<string>\",\n  \"autoDestroy\": true,\n  \"oneShot\": true,\n  \"blockOutbound\": true,\n  \"egress\": {\n    \"allow\": [\n      \"<string>\"\n    ]\n  },\n  \"persistent\": true,\n  \"persistentDiskGB\": 123,\n  \"volumeId\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"fromSnapshot\": \"<string>\",\n  \"snapshotFrequency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.brimble.io/core/v1/sandboxes")

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  \"template\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"environmentId\": \"<string>\",\n  \"region\": \"<string>\",\n  \"size\": \"<string>\",\n  \"autoDestroy\": true,\n  \"oneShot\": true,\n  \"blockOutbound\": true,\n  \"egress\": {\n    \"allow\": [\n      \"<string>\"\n    ]\n  },\n  \"persistent\": true,\n  \"persistentDiskGB\": 123,\n  \"volumeId\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"fromSnapshot\": \"<string>\",\n  \"snapshotFrequency\": \"<string>\"\n}"

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

{
  "message": "Sandbox created",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "template": "<string>",
    "size": "<string>",
    "status": "starting",
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "errors": [
    {
      "type": "field",
      "value": "<unknown>",
      "msg": "Invalid value",
      "path": "name",
      "location": "body"
    }
  ]
}

{
  "message": "Project not found",
  "data": {}
}

{
  "message": "Project not found",
  "data": {}
}

{
  "message": "Project not found",
  "data": {}
}

POST

sandboxes

Create a sandbox

curl --request POST \
  --url https://api.brimble.io/core/v1/sandboxes \
  --header 'Content-Type: application/json' \
  --header 'x-brimble-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "template": "<string>",
  "teamId": "<string>",
  "environmentId": "<string>",
  "region": "<string>",
  "size": "<string>",
  "autoDestroy": true,
  "oneShot": true,
  "blockOutbound": true,
  "egress": {
    "allow": [
      "<string>"
    ]
  },
  "persistent": true,
  "persistentDiskGB": 123,
  "volumeId": "<string>",
  "mountPath": "<string>",
  "fromSnapshot": "<string>",
  "snapshotFrequency": "<string>"
}
'

import requests

url = "https://api.brimble.io/core/v1/sandboxes"

payload = {
    "name": "<string>",
    "template": "<string>",
    "teamId": "<string>",
    "environmentId": "<string>",
    "region": "<string>",
    "size": "<string>",
    "autoDestroy": True,
    "oneShot": True,
    "blockOutbound": True,
    "egress": { "allow": ["<string>"] },
    "persistent": True,
    "persistentDiskGB": 123,
    "volumeId": "<string>",
    "mountPath": "<string>",
    "fromSnapshot": "<string>",
    "snapshotFrequency": "<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>',
    template: '<string>',
    teamId: '<string>',
    environmentId: '<string>',
    region: '<string>',
    size: '<string>',
    autoDestroy: true,
    oneShot: true,
    blockOutbound: true,
    egress: {allow: ['<string>']},
    persistent: true,
    persistentDiskGB: 123,
    volumeId: '<string>',
    mountPath: '<string>',
    fromSnapshot: '<string>',
    snapshotFrequency: '<string>'
  })
};

fetch('https://api.brimble.io/core/v1/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://api.brimble.io/core/v1/sandboxes",
  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>',
    'template' => '<string>',
    'teamId' => '<string>',
    'environmentId' => '<string>',
    'region' => '<string>',
    'size' => '<string>',
    'autoDestroy' => true,
    'oneShot' => true,
    'blockOutbound' => true,
    'egress' => [
        'allow' => [
                '<string>'
        ]
    ],
    'persistent' => true,
    'persistentDiskGB' => 123,
    'volumeId' => '<string>',
    'mountPath' => '<string>',
    'fromSnapshot' => '<string>',
    'snapshotFrequency' => '<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://api.brimble.io/core/v1/sandboxes"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"template\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"environmentId\": \"<string>\",\n  \"region\": \"<string>\",\n  \"size\": \"<string>\",\n  \"autoDestroy\": true,\n  \"oneShot\": true,\n  \"blockOutbound\": true,\n  \"egress\": {\n    \"allow\": [\n      \"<string>\"\n    ]\n  },\n  \"persistent\": true,\n  \"persistentDiskGB\": 123,\n  \"volumeId\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"fromSnapshot\": \"<string>\",\n  \"snapshotFrequency\": \"<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://api.brimble.io/core/v1/sandboxes")
  .header("x-brimble-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"template\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"environmentId\": \"<string>\",\n  \"region\": \"<string>\",\n  \"size\": \"<string>\",\n  \"autoDestroy\": true,\n  \"oneShot\": true,\n  \"blockOutbound\": true,\n  \"egress\": {\n    \"allow\": [\n      \"<string>\"\n    ]\n  },\n  \"persistent\": true,\n  \"persistentDiskGB\": 123,\n  \"volumeId\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"fromSnapshot\": \"<string>\",\n  \"snapshotFrequency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.brimble.io/core/v1/sandboxes")

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  \"template\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"environmentId\": \"<string>\",\n  \"region\": \"<string>\",\n  \"size\": \"<string>\",\n  \"autoDestroy\": true,\n  \"oneShot\": true,\n  \"blockOutbound\": true,\n  \"egress\": {\n    \"allow\": [\n      \"<string>\"\n    ]\n  },\n  \"persistent\": true,\n  \"persistentDiskGB\": 123,\n  \"volumeId\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"fromSnapshot\": \"<string>\",\n  \"snapshotFrequency\": \"<string>\"\n}"

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

{
  "message": "Sandbox created",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "template": "<string>",
    "size": "<string>",
    "status": "starting",
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "errors": [
    {
      "type": "field",
      "value": "<unknown>",
      "msg": "Invalid value",
      "path": "name",
      "location": "body"
    }
  ]
}

{
  "message": "Project not found",
  "data": {}
}

{
  "message": "Project not found",
  "data": {}
}

{
  "message": "Project not found",
  "data": {}
}

Authorizations

x-brimble-key

string

header

required

API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.

Body

application/json

name

string

Name of the sandbox, up to 64 characters. Omit to generate one.

Required string length: 1 - 64

template

string

Template (base image) to start from, for example python-3.12. Defaults to python-3.12.

Required string length: 1 - 64

teamId

string

Team to act in. Omit for your personal workspace.

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

environmentId

string

Environment to create the sandbox in. Omit to use the default environment.

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

region

string

Region ID or slug, for example eu-west. Omit to use the default region.

size

string

Size preset, for example sbx.micro. Sets CPU, memory and disk. Omit to use your plan's default.

autoDestroy

boolean

Destroy the sandbox after destroyTimeout of inactivity.

destroyTimeout

enum<string>

Idle time before the sandbox is destroyed: 30m, 1h, 3h, 6h, 12h or 18h. Required when autoDestroy is true.

Available options:

30m,

1h,

3h,

6h,

12h,

18h

oneShot

boolean

Destroy the sandbox as soon as it stops.

blockOutbound

boolean

Block all outbound network traffic. Cannot be combined with egress.

egress

object

Outbound network rules. Cannot be combined with blockOutbound.

Show child attributes

persistent

boolean

Give the sandbox a persistent disk that survives restarts. Requires mountPath.

persistentDiskGB

integer

Size of the persistent disk, in GB. Required when persistent is true.

volumeId

string | null

Attach an existing volume. Requires mountPath. Cannot be combined with persistent.

mountPath

string | null

Absolute path where the disk or volume is mounted, for example /workspace. Cannot be /.

fromSnapshot

string

ID of a snapshot to restore. The sandbox starts with the snapshot's files and template.

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

snapshotMode

enum<string>

automatic takes snapshots on snapshotFrequency; manual only when you ask.

Available options:

automatic,

manual

snapshotFrequency

string | null

Cron expression for automatic snapshots, for example 0 * * * *. Required when snapshotMode is automatic.

Response

Sandbox created

message

string

required

Human-readable result of the request.

Example:

"Sandbox created"

data

object

required

Show child attributes

Last modified on October 31, 2026

Getting started

Projects

Deployments and Logs

Environments

Secrets

Webhooks

Git Providers

Domains

Databases

Log Drains

Sandboxes

Object Storage

Scaling and Networking

Teams

Catalog

Create a sandbox

Authorizations

Body

Response