Skip to main content
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>"
}
'
{
  "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
Last modified on May 23, 2026