Get a bucket
curl --request GET \
--url https://api.brimble.io/core/v1/storage/buckets/{bucketId} \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/storage/buckets/{bucketId}"
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://api.brimble.io/core/v1/storage/buckets/{bucketId}', 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/storage/buckets/{bucketId}",
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://api.brimble.io/core/v1/storage/buckets/{bucketId}"
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://api.brimble.io/core/v1/storage/buckets/{bucketId}")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/storage/buckets/{bucketId}")
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": "Storage bucket fetched",
"data": {
"storage_used": 123,
"objectCount": 123,
"url": "<string>",
"_id": "6a81bed11470bfcd2a5dbcfa",
"name": "<string>",
"project": "6a81bed11470bfcd2a5dbcfa",
"project_environment": "6a81bed11470bfcd2a5dbcfa",
"user_id": "6a81bed11470bfcd2a5dbcfa",
"team": "6a81bed11470bfcd2a5dbcfa",
"bucket_name": "<string>",
"provider": "<string>",
"is_public": true,
"versioning": true,
"region": "<string>",
"storage_increased_by": 123,
"storage_decreased_by": 123,
"reserved_bytes": 123,
"cors_rules": [
{
"allowedOrigins": [
"<string>"
],
"allowedHeaders": [
"<string>"
],
"allowedMethods": [
"<string>"
],
"exposeHeaders": [
"<string>"
],
"maxAgeSeconds": 123
}
],
"lifecycle_rules": [
{
"id": "<string>",
"prefix": "<string>",
"expirationDays": 123,
"transitions": [
{
"days": 123,
"storageClass": "<string>"
}
]
}
],
"status": "active",
"starred": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"capabilities": {
"cors": true,
"publicToggle": true,
"customDomain": true,
"lifecycle": true,
"versioning": true,
"bucketPolicy": true,
"objectAcl": true,
"publicWebsite": true,
"copyObject": true,
"objectTagging": true,
"notifications": true,
"replication": true,
"select": true,
"objectLock": true,
"inventory": true,
"nativeIam": true
}
}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Object Storage
Get a bucket
API key scope: storage.read
Team role permission: storage.read
GET
/
v1
/
storage
/
buckets
/
{bucketId}
Get a bucket
curl --request GET \
--url https://api.brimble.io/core/v1/storage/buckets/{bucketId} \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/storage/buckets/{bucketId}"
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://api.brimble.io/core/v1/storage/buckets/{bucketId}', 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/storage/buckets/{bucketId}",
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://api.brimble.io/core/v1/storage/buckets/{bucketId}"
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://api.brimble.io/core/v1/storage/buckets/{bucketId}")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/storage/buckets/{bucketId}")
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": "Storage bucket fetched",
"data": {
"storage_used": 123,
"objectCount": 123,
"url": "<string>",
"_id": "6a81bed11470bfcd2a5dbcfa",
"name": "<string>",
"project": "6a81bed11470bfcd2a5dbcfa",
"project_environment": "6a81bed11470bfcd2a5dbcfa",
"user_id": "6a81bed11470bfcd2a5dbcfa",
"team": "6a81bed11470bfcd2a5dbcfa",
"bucket_name": "<string>",
"provider": "<string>",
"is_public": true,
"versioning": true,
"region": "<string>",
"storage_increased_by": 123,
"storage_decreased_by": 123,
"reserved_bytes": 123,
"cors_rules": [
{
"allowedOrigins": [
"<string>"
],
"allowedHeaders": [
"<string>"
],
"allowedMethods": [
"<string>"
],
"exposeHeaders": [
"<string>"
],
"maxAgeSeconds": 123
}
],
"lifecycle_rules": [
{
"id": "<string>",
"prefix": "<string>",
"expirationDays": 123,
"transitions": [
{
"days": 123,
"storageClass": "<string>"
}
]
}
],
"status": "active",
"starred": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"capabilities": {
"cors": true,
"publicToggle": true,
"customDomain": true,
"lifecycle": true,
"versioning": true,
"bucketPolicy": true,
"objectAcl": true,
"publicWebsite": true,
"copyObject": true,
"objectTagging": true,
"notifications": true,
"replication": true,
"select": true,
"objectLock": true,
"inventory": true,
"nativeIam": true
}
}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Authorizations
ApiKeyAuthBearerAuth
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
Path Parameters
Query Parameters
Team to act in. Omit for your personal workspace. API keys created for a team use that team automatically.
Pattern:
^[a-fA-F0-9]{24}$Example:
"6a81bed11470bfcd2a5dbcfa"
Last modified on October 10, 2026
Was this page helpful?