Volumes

Create a volume

Provisions a persistent volume synchronously. Volumes are backed by Brimble’s globally distributed S3-compatible object storage; when the response returns the disk is allocated and ready to attach to a sandbox or project.

Names are unique per user. Region is permanently pinned at creation; volumes can only attach to sandboxes / projects in the same region.

type declares the surface this volume is intended for and drives where it shows up in attach pickers:

web, project disk (default)
sandbox, sandbox disk

POST

volumes

Create a volume

curl --request POST \
  --url https://sandbox.brimble.io/volumes \
  --header 'Content-Type: application/json' \
  --header 'x-brimble-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "sizeGB": 30,
  "region": "<string>",
  "teamId": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "sizeGB": 30,
    "region": "<string>",
    "teamId": "<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>', sizeGB: 30, region: '<string>', teamId: '<string>'})
};

fetch('https://sandbox.brimble.io/volumes', 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/volumes",
  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>',
    'sizeGB' => 30,
    'region' => '<string>',
    'teamId' => '<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/volumes"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"sizeGB\": 30,\n  \"region\": \"<string>\",\n  \"teamId\": \"<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/volumes")
  .header("x-brimble-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"sizeGB\": 30,\n  \"region\": \"<string>\",\n  \"teamId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sizeGB\": 30,\n  \"region\": \"<string>\",\n  \"teamId\": \"<string>\"\n}"

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

{
  "message": "Volume fetched",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "size": 123,
    "attached_sandbox_id": "<string>",
    "attached_project_id": "<string>",
    "team": "<string>",
    "volume_handle": "<string>",
    "region": {
      "id": "6a06df21cc6bef51342e199e",
      "name": "eu-west",
      "country": "France",
      "continent": "Europe",
      "enabled": true,
      "type": "sandbox"
    },
    "mount_path": "<string>",
    "last_attached_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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.

Body

application/json

name

string

required

Lowercase letters, digits, hyphens; 1–40 chars. Unique per user.

Pattern: ^[a-z0-9-]{1,40}$

sizeGB

integer

required

Disk size in GB. Subject to plan caps.

Required range: 10 <= x <= 50

region

string

required

Region id from GET /v1/regions. Cannot be changed after creation.

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

type

enum<string>

Defaults to web when omitted.

Available options:

web,

sandbox

teamId

string

Create the volume under a team you're a member of. Copy the team ID from the team's settings page in the dashboard. Omit for a personal volume.

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

Response

Volume created

message

string

required

Example:

"Volume fetched"

data

object

required

Show child attributes

Last modified on July 1, 2026

Get a volume

Create a volume

curl --request POST \
  --url https://sandbox.brimble.io/volumes \
  --header 'Content-Type: application/json' \
  --header 'x-brimble-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "sizeGB": 30,
  "region": "<string>",
  "teamId": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "sizeGB": 30,
    "region": "<string>",
    "teamId": "<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>', sizeGB: 30, region: '<string>', teamId: '<string>'})
};

fetch('https://sandbox.brimble.io/volumes', 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/volumes",
  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>',
    'sizeGB' => 30,
    'region' => '<string>',
    'teamId' => '<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/volumes"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"sizeGB\": 30,\n  \"region\": \"<string>\",\n  \"teamId\": \"<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/volumes")
  .header("x-brimble-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"sizeGB\": 30,\n  \"region\": \"<string>\",\n  \"teamId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sizeGB\": 30,\n  \"region\": \"<string>\",\n  \"teamId\": \"<string>\"\n}"

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

{
  "message": "Volume fetched",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "size": 123,
    "attached_sandbox_id": "<string>",
    "attached_project_id": "<string>",
    "team": "<string>",
    "volume_handle": "<string>",
    "region": {
      "id": "6a06df21cc6bef51342e199e",
      "name": "eu-west",
      "country": "France",
      "continent": "Europe",
      "enabled": true,
      "type": "sandbox"
    },
    "mount_path": "<string>",
    "last_attached_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Discovery

Sandboxes

Runtime

Observability

Snapshots

Volumes

Sandboxes

Snapshots

Observability

Runtime

Volumes

Create a volume

Authorizations

Body

Response