Create a bucket
curl --request POST \
--url https://api.brimble.io/core/v1/storage/buckets \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"isPublic": true,
"corsRules": [
{
"allowedHeaders": [
"<string>"
],
"allowedMethods": [
"<string>"
],
"allowedOrigins": [
"<string>"
],
"exposeHeaders": [
"<string>"
],
"maxAgeSeconds": 123
}
],
"lifecycleRules": [
{
"id": "<string>",
"prefix": "<string>",
"expirationDays": 123,
"transitions": [
{
"days": 123,
"storageClass": "<string>"
}
]
}
],
"browserUploadOrigins": [
"<string>"
],
"teamId": "<string>"
}
'import requests
url = "https://api.brimble.io/core/v1/storage/buckets"
payload = {
"name": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"isPublic": True,
"corsRules": [
{
"allowedHeaders": ["<string>"],
"allowedMethods": ["<string>"],
"allowedOrigins": ["<string>"],
"exposeHeaders": ["<string>"],
"maxAgeSeconds": 123
}
],
"lifecycleRules": [
{
"id": "<string>",
"prefix": "<string>",
"expirationDays": 123,
"transitions": [
{
"days": 123,
"storageClass": "<string>"
}
]
}
],
"browserUploadOrigins": ["<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>',
projectId: '<string>',
environmentId: '<string>',
isPublic: true,
corsRules: [
{
allowedHeaders: ['<string>'],
allowedMethods: ['<string>'],
allowedOrigins: ['<string>'],
exposeHeaders: ['<string>'],
maxAgeSeconds: 123
}
],
lifecycleRules: [
{
id: '<string>',
prefix: '<string>',
expirationDays: 123,
transitions: [{days: 123, storageClass: '<string>'}]
}
],
browserUploadOrigins: ['<string>'],
teamId: '<string>'
})
};
fetch('https://api.brimble.io/core/v1/storage/buckets', 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",
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>',
'projectId' => '<string>',
'environmentId' => '<string>',
'isPublic' => true,
'corsRules' => [
[
'allowedHeaders' => [
'<string>'
],
'allowedMethods' => [
'<string>'
],
'allowedOrigins' => [
'<string>'
],
'exposeHeaders' => [
'<string>'
],
'maxAgeSeconds' => 123
]
],
'lifecycleRules' => [
[
'id' => '<string>',
'prefix' => '<string>',
'expirationDays' => 123,
'transitions' => [
[
'days' => 123,
'storageClass' => '<string>'
]
]
]
],
'browserUploadOrigins' => [
'<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://api.brimble.io/core/v1/storage/buckets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"isPublic\": true,\n \"corsRules\": [\n {\n \"allowedHeaders\": [\n \"<string>\"\n ],\n \"allowedMethods\": [\n \"<string>\"\n ],\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"exposeHeaders\": [\n \"<string>\"\n ],\n \"maxAgeSeconds\": 123\n }\n ],\n \"lifecycleRules\": [\n {\n \"id\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expirationDays\": 123,\n \"transitions\": [\n {\n \"days\": 123,\n \"storageClass\": \"<string>\"\n }\n ]\n }\n ],\n \"browserUploadOrigins\": [\n \"<string>\"\n ],\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://api.brimble.io/core/v1/storage/buckets")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"isPublic\": true,\n \"corsRules\": [\n {\n \"allowedHeaders\": [\n \"<string>\"\n ],\n \"allowedMethods\": [\n \"<string>\"\n ],\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"exposeHeaders\": [\n \"<string>\"\n ],\n \"maxAgeSeconds\": 123\n }\n ],\n \"lifecycleRules\": [\n {\n \"id\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expirationDays\": 123,\n \"transitions\": [\n {\n \"days\": 123,\n \"storageClass\": \"<string>\"\n }\n ]\n }\n ],\n \"browserUploadOrigins\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/storage/buckets")
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 \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"isPublic\": true,\n \"corsRules\": [\n {\n \"allowedHeaders\": [\n \"<string>\"\n ],\n \"allowedMethods\": [\n \"<string>\"\n ],\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"exposeHeaders\": [\n \"<string>\"\n ],\n \"maxAgeSeconds\": 123\n }\n ],\n \"lifecycleRules\": [\n {\n \"id\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expirationDays\": 123,\n \"transitions\": [\n {\n \"days\": 123,\n \"storageClass\": \"<string>\"\n }\n ]\n }\n ],\n \"browserUploadOrigins\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Storage bucket created",
"data": {
"_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_used": 123,
"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",
"url": "<string>",
"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
}
}
}{
"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": {}
}Object Storage
Create a bucket
API key scope: storage.create
Team role permission: storage.create
POST
/
v1
/
storage
/
buckets
Create a bucket
curl --request POST \
--url https://api.brimble.io/core/v1/storage/buckets \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"isPublic": true,
"corsRules": [
{
"allowedHeaders": [
"<string>"
],
"allowedMethods": [
"<string>"
],
"allowedOrigins": [
"<string>"
],
"exposeHeaders": [
"<string>"
],
"maxAgeSeconds": 123
}
],
"lifecycleRules": [
{
"id": "<string>",
"prefix": "<string>",
"expirationDays": 123,
"transitions": [
{
"days": 123,
"storageClass": "<string>"
}
]
}
],
"browserUploadOrigins": [
"<string>"
],
"teamId": "<string>"
}
'import requests
url = "https://api.brimble.io/core/v1/storage/buckets"
payload = {
"name": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"isPublic": True,
"corsRules": [
{
"allowedHeaders": ["<string>"],
"allowedMethods": ["<string>"],
"allowedOrigins": ["<string>"],
"exposeHeaders": ["<string>"],
"maxAgeSeconds": 123
}
],
"lifecycleRules": [
{
"id": "<string>",
"prefix": "<string>",
"expirationDays": 123,
"transitions": [
{
"days": 123,
"storageClass": "<string>"
}
]
}
],
"browserUploadOrigins": ["<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>',
projectId: '<string>',
environmentId: '<string>',
isPublic: true,
corsRules: [
{
allowedHeaders: ['<string>'],
allowedMethods: ['<string>'],
allowedOrigins: ['<string>'],
exposeHeaders: ['<string>'],
maxAgeSeconds: 123
}
],
lifecycleRules: [
{
id: '<string>',
prefix: '<string>',
expirationDays: 123,
transitions: [{days: 123, storageClass: '<string>'}]
}
],
browserUploadOrigins: ['<string>'],
teamId: '<string>'
})
};
fetch('https://api.brimble.io/core/v1/storage/buckets', 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",
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>',
'projectId' => '<string>',
'environmentId' => '<string>',
'isPublic' => true,
'corsRules' => [
[
'allowedHeaders' => [
'<string>'
],
'allowedMethods' => [
'<string>'
],
'allowedOrigins' => [
'<string>'
],
'exposeHeaders' => [
'<string>'
],
'maxAgeSeconds' => 123
]
],
'lifecycleRules' => [
[
'id' => '<string>',
'prefix' => '<string>',
'expirationDays' => 123,
'transitions' => [
[
'days' => 123,
'storageClass' => '<string>'
]
]
]
],
'browserUploadOrigins' => [
'<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://api.brimble.io/core/v1/storage/buckets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"isPublic\": true,\n \"corsRules\": [\n {\n \"allowedHeaders\": [\n \"<string>\"\n ],\n \"allowedMethods\": [\n \"<string>\"\n ],\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"exposeHeaders\": [\n \"<string>\"\n ],\n \"maxAgeSeconds\": 123\n }\n ],\n \"lifecycleRules\": [\n {\n \"id\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expirationDays\": 123,\n \"transitions\": [\n {\n \"days\": 123,\n \"storageClass\": \"<string>\"\n }\n ]\n }\n ],\n \"browserUploadOrigins\": [\n \"<string>\"\n ],\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://api.brimble.io/core/v1/storage/buckets")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"isPublic\": true,\n \"corsRules\": [\n {\n \"allowedHeaders\": [\n \"<string>\"\n ],\n \"allowedMethods\": [\n \"<string>\"\n ],\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"exposeHeaders\": [\n \"<string>\"\n ],\n \"maxAgeSeconds\": 123\n }\n ],\n \"lifecycleRules\": [\n {\n \"id\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expirationDays\": 123,\n \"transitions\": [\n {\n \"days\": 123,\n \"storageClass\": \"<string>\"\n }\n ]\n }\n ],\n \"browserUploadOrigins\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/storage/buckets")
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 \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"isPublic\": true,\n \"corsRules\": [\n {\n \"allowedHeaders\": [\n \"<string>\"\n ],\n \"allowedMethods\": [\n \"<string>\"\n ],\n \"allowedOrigins\": [\n \"<string>\"\n ],\n \"exposeHeaders\": [\n \"<string>\"\n ],\n \"maxAgeSeconds\": 123\n }\n ],\n \"lifecycleRules\": [\n {\n \"id\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expirationDays\": 123,\n \"transitions\": [\n {\n \"days\": 123,\n \"storageClass\": \"<string>\"\n }\n ]\n }\n ],\n \"browserUploadOrigins\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Storage bucket created",
"data": {
"_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_used": 123,
"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",
"url": "<string>",
"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
}
}
}{
"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
ApiKeyAuthBearerAuth
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
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"
Body
application/json
Bucket name must be at least 3 characters
Minimum string length:
3Pattern:
^[a-fA-F0-9]{24}$Pattern:
^[a-fA-F0-9]{24}$Available options:
ams, apac, auto, eeur, enam, fra, global, iad, lhr, los, nrt, oc, ord, sin, sjc, weur, wnam Show child attributes
Show child attributes
Show child attributes
Show child attributes
Team to act in. Omit for your personal workspace.
Pattern:
^[a-fA-F0-9]{24}$Last modified on October 10, 2026
Was this page helpful?