Volumes
Get a volume
GET
/
volumes
/
{volumeId}
Get a volume
curl --request GET \
--url https://sandbox.brimble.io/volumes/{volumeId} \
--header 'x-brimble-key: <api-key>'import requests
url = "https://sandbox.brimble.io/volumes/{volumeId}"
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/volumes/{volumeId}', 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/{volumeId}",
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/volumes/{volumeId}"
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/volumes/{volumeId}")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brimble.io/volumes/{volumeId}")
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": "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
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
24-char hex id of the volume.
Pattern:
^[a-f0-9]{24}$Last modified on July 23, 2026
Was this page helpful?
Previous
Delete a volumeHard-deletes the volume. The underlying disk and all data on it are
destroyed, irreversible.
Fails with `400 "Volume is attached; detach it before deleting"` if the
volume is currently attached to a sandbox or project. Detach the volume
first (destroy the sandbox or detach via the project flow), then delete.
Next
⌘I
Get a volume
curl --request GET \
--url https://sandbox.brimble.io/volumes/{volumeId} \
--header 'x-brimble-key: <api-key>'import requests
url = "https://sandbox.brimble.io/volumes/{volumeId}"
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/volumes/{volumeId}', 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/{volumeId}",
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/volumes/{volumeId}"
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/volumes/{volumeId}")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.brimble.io/volumes/{volumeId}")
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": "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"
}
}