Create a database
curl --request POST \
--url https://api.brimble.io/core/v1/projects/database \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"dbImage": "<string>",
"environments": [
{
"name": "<string>",
"value": "<string>"
}
],
"configurations": {
"cpu": 123,
"memory": 123,
"storage": 123,
"region": "<string>"
},
"teamId": "<string>",
"environmentId": "<string>",
"ha": true,
"secondaryRegions": [
"<string>"
],
"tlsEnabled": true,
"pgbouncerEnabled": true,
"pgbouncerConfig": {
"defaultPoolSize": 50,
"maxDbConnections": 250,
"maxDbClientConnections": 2500,
"maxUserConnections": 250,
"maxClientConn": 5000,
"maxPreparedStatements": 5000,
"serverLifetime": 43230,
"serverIdleTimeout": 43205
},
"whitelistedIps": [
"<string>"
],
"deploy": true,
"volumeId": "<string>",
"linkedProjectIds": [
"<string>"
],
"public": true
}
'import requests
url = "https://api.brimble.io/core/v1/projects/database"
payload = {
"name": "<string>",
"dbImage": "<string>",
"environments": [
{
"name": "<string>",
"value": "<string>"
}
],
"configurations": {
"cpu": 123,
"memory": 123,
"storage": 123,
"region": "<string>"
},
"teamId": "<string>",
"environmentId": "<string>",
"ha": True,
"secondaryRegions": ["<string>"],
"tlsEnabled": True,
"pgbouncerEnabled": True,
"pgbouncerConfig": {
"defaultPoolSize": 50,
"maxDbConnections": 250,
"maxDbClientConnections": 2500,
"maxUserConnections": 250,
"maxClientConn": 5000,
"maxPreparedStatements": 5000,
"serverLifetime": 43230,
"serverIdleTimeout": 43205
},
"whitelistedIps": ["<string>"],
"deploy": True,
"volumeId": "<string>",
"linkedProjectIds": ["<string>"],
"public": True
}
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>',
dbImage: '<string>',
environments: [{name: '<string>', value: '<string>'}],
configurations: {cpu: 123, memory: 123, storage: 123, region: '<string>'},
teamId: '<string>',
environmentId: '<string>',
ha: true,
secondaryRegions: ['<string>'],
tlsEnabled: true,
pgbouncerEnabled: true,
pgbouncerConfig: {
defaultPoolSize: 50,
maxDbConnections: 250,
maxDbClientConnections: 2500,
maxUserConnections: 250,
maxClientConn: 5000,
maxPreparedStatements: 5000,
serverLifetime: 43230,
serverIdleTimeout: 43205
},
whitelistedIps: ['<string>'],
deploy: true,
volumeId: '<string>',
linkedProjectIds: ['<string>'],
public: true
})
};
fetch('https://api.brimble.io/core/v1/projects/database', 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/projects/database",
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>',
'dbImage' => '<string>',
'environments' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'configurations' => [
'cpu' => 123,
'memory' => 123,
'storage' => 123,
'region' => '<string>'
],
'teamId' => '<string>',
'environmentId' => '<string>',
'ha' => true,
'secondaryRegions' => [
'<string>'
],
'tlsEnabled' => true,
'pgbouncerEnabled' => true,
'pgbouncerConfig' => [
'defaultPoolSize' => 50,
'maxDbConnections' => 250,
'maxDbClientConnections' => 2500,
'maxUserConnections' => 250,
'maxClientConn' => 5000,
'maxPreparedStatements' => 5000,
'serverLifetime' => 43230,
'serverIdleTimeout' => 43205
],
'whitelistedIps' => [
'<string>'
],
'deploy' => true,
'volumeId' => '<string>',
'linkedProjectIds' => [
'<string>'
],
'public' => true
]),
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/projects/database"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"dbImage\": \"<string>\",\n \"environments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"configurations\": {\n \"cpu\": 123,\n \"memory\": 123,\n \"storage\": 123,\n \"region\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"ha\": true,\n \"secondaryRegions\": [\n \"<string>\"\n ],\n \"tlsEnabled\": true,\n \"pgbouncerEnabled\": true,\n \"pgbouncerConfig\": {\n \"defaultPoolSize\": 50,\n \"maxDbConnections\": 250,\n \"maxDbClientConnections\": 2500,\n \"maxUserConnections\": 250,\n \"maxClientConn\": 5000,\n \"maxPreparedStatements\": 5000,\n \"serverLifetime\": 43230,\n \"serverIdleTimeout\": 43205\n },\n \"whitelistedIps\": [\n \"<string>\"\n ],\n \"deploy\": true,\n \"volumeId\": \"<string>\",\n \"linkedProjectIds\": [\n \"<string>\"\n ],\n \"public\": true\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/projects/database")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"dbImage\": \"<string>\",\n \"environments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"configurations\": {\n \"cpu\": 123,\n \"memory\": 123,\n \"storage\": 123,\n \"region\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"ha\": true,\n \"secondaryRegions\": [\n \"<string>\"\n ],\n \"tlsEnabled\": true,\n \"pgbouncerEnabled\": true,\n \"pgbouncerConfig\": {\n \"defaultPoolSize\": 50,\n \"maxDbConnections\": 250,\n \"maxDbClientConnections\": 2500,\n \"maxUserConnections\": 250,\n \"maxClientConn\": 5000,\n \"maxPreparedStatements\": 5000,\n \"serverLifetime\": 43230,\n \"serverIdleTimeout\": 43205\n },\n \"whitelistedIps\": [\n \"<string>\"\n ],\n \"deploy\": true,\n \"volumeId\": \"<string>\",\n \"linkedProjectIds\": [\n \"<string>\"\n ],\n \"public\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/projects/database")
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 \"dbImage\": \"<string>\",\n \"environments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"configurations\": {\n \"cpu\": 123,\n \"memory\": 123,\n \"storage\": 123,\n \"region\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"ha\": true,\n \"secondaryRegions\": [\n \"<string>\"\n ],\n \"tlsEnabled\": true,\n \"pgbouncerEnabled\": true,\n \"pgbouncerConfig\": {\n \"defaultPoolSize\": 50,\n \"maxDbConnections\": 250,\n \"maxDbClientConnections\": 2500,\n \"maxUserConnections\": 250,\n \"maxClientConn\": 5000,\n \"maxPreparedStatements\": 5000,\n \"serverLifetime\": 43230,\n \"serverIdleTimeout\": 43205\n },\n \"whitelistedIps\": [\n \"<string>\"\n ],\n \"deploy\": true,\n \"volumeId\": \"<string>\",\n \"linkedProjectIds\": [\n \"<string>\"\n ],\n \"public\": true\n}"
response = http.request(request)
puts response.read_body{
"message": "Operation performed successfully",
"data": {
"id": "6a81bed11470bfcd2a5dbcfa",
"name": "<string>",
"url": "<string>"
}
}{
"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": {}
}Databases
Create a database
API key scope: project.create
Team role permission: project.create
POST
/
v1
/
projects
/
database
Create a database
curl --request POST \
--url https://api.brimble.io/core/v1/projects/database \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"dbImage": "<string>",
"environments": [
{
"name": "<string>",
"value": "<string>"
}
],
"configurations": {
"cpu": 123,
"memory": 123,
"storage": 123,
"region": "<string>"
},
"teamId": "<string>",
"environmentId": "<string>",
"ha": true,
"secondaryRegions": [
"<string>"
],
"tlsEnabled": true,
"pgbouncerEnabled": true,
"pgbouncerConfig": {
"defaultPoolSize": 50,
"maxDbConnections": 250,
"maxDbClientConnections": 2500,
"maxUserConnections": 250,
"maxClientConn": 5000,
"maxPreparedStatements": 5000,
"serverLifetime": 43230,
"serverIdleTimeout": 43205
},
"whitelistedIps": [
"<string>"
],
"deploy": true,
"volumeId": "<string>",
"linkedProjectIds": [
"<string>"
],
"public": true
}
'import requests
url = "https://api.brimble.io/core/v1/projects/database"
payload = {
"name": "<string>",
"dbImage": "<string>",
"environments": [
{
"name": "<string>",
"value": "<string>"
}
],
"configurations": {
"cpu": 123,
"memory": 123,
"storage": 123,
"region": "<string>"
},
"teamId": "<string>",
"environmentId": "<string>",
"ha": True,
"secondaryRegions": ["<string>"],
"tlsEnabled": True,
"pgbouncerEnabled": True,
"pgbouncerConfig": {
"defaultPoolSize": 50,
"maxDbConnections": 250,
"maxDbClientConnections": 2500,
"maxUserConnections": 250,
"maxClientConn": 5000,
"maxPreparedStatements": 5000,
"serverLifetime": 43230,
"serverIdleTimeout": 43205
},
"whitelistedIps": ["<string>"],
"deploy": True,
"volumeId": "<string>",
"linkedProjectIds": ["<string>"],
"public": True
}
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>',
dbImage: '<string>',
environments: [{name: '<string>', value: '<string>'}],
configurations: {cpu: 123, memory: 123, storage: 123, region: '<string>'},
teamId: '<string>',
environmentId: '<string>',
ha: true,
secondaryRegions: ['<string>'],
tlsEnabled: true,
pgbouncerEnabled: true,
pgbouncerConfig: {
defaultPoolSize: 50,
maxDbConnections: 250,
maxDbClientConnections: 2500,
maxUserConnections: 250,
maxClientConn: 5000,
maxPreparedStatements: 5000,
serverLifetime: 43230,
serverIdleTimeout: 43205
},
whitelistedIps: ['<string>'],
deploy: true,
volumeId: '<string>',
linkedProjectIds: ['<string>'],
public: true
})
};
fetch('https://api.brimble.io/core/v1/projects/database', 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/projects/database",
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>',
'dbImage' => '<string>',
'environments' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'configurations' => [
'cpu' => 123,
'memory' => 123,
'storage' => 123,
'region' => '<string>'
],
'teamId' => '<string>',
'environmentId' => '<string>',
'ha' => true,
'secondaryRegions' => [
'<string>'
],
'tlsEnabled' => true,
'pgbouncerEnabled' => true,
'pgbouncerConfig' => [
'defaultPoolSize' => 50,
'maxDbConnections' => 250,
'maxDbClientConnections' => 2500,
'maxUserConnections' => 250,
'maxClientConn' => 5000,
'maxPreparedStatements' => 5000,
'serverLifetime' => 43230,
'serverIdleTimeout' => 43205
],
'whitelistedIps' => [
'<string>'
],
'deploy' => true,
'volumeId' => '<string>',
'linkedProjectIds' => [
'<string>'
],
'public' => true
]),
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/projects/database"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"dbImage\": \"<string>\",\n \"environments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"configurations\": {\n \"cpu\": 123,\n \"memory\": 123,\n \"storage\": 123,\n \"region\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"ha\": true,\n \"secondaryRegions\": [\n \"<string>\"\n ],\n \"tlsEnabled\": true,\n \"pgbouncerEnabled\": true,\n \"pgbouncerConfig\": {\n \"defaultPoolSize\": 50,\n \"maxDbConnections\": 250,\n \"maxDbClientConnections\": 2500,\n \"maxUserConnections\": 250,\n \"maxClientConn\": 5000,\n \"maxPreparedStatements\": 5000,\n \"serverLifetime\": 43230,\n \"serverIdleTimeout\": 43205\n },\n \"whitelistedIps\": [\n \"<string>\"\n ],\n \"deploy\": true,\n \"volumeId\": \"<string>\",\n \"linkedProjectIds\": [\n \"<string>\"\n ],\n \"public\": true\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/projects/database")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"dbImage\": \"<string>\",\n \"environments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"configurations\": {\n \"cpu\": 123,\n \"memory\": 123,\n \"storage\": 123,\n \"region\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"ha\": true,\n \"secondaryRegions\": [\n \"<string>\"\n ],\n \"tlsEnabled\": true,\n \"pgbouncerEnabled\": true,\n \"pgbouncerConfig\": {\n \"defaultPoolSize\": 50,\n \"maxDbConnections\": 250,\n \"maxDbClientConnections\": 2500,\n \"maxUserConnections\": 250,\n \"maxClientConn\": 5000,\n \"maxPreparedStatements\": 5000,\n \"serverLifetime\": 43230,\n \"serverIdleTimeout\": 43205\n },\n \"whitelistedIps\": [\n \"<string>\"\n ],\n \"deploy\": true,\n \"volumeId\": \"<string>\",\n \"linkedProjectIds\": [\n \"<string>\"\n ],\n \"public\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/projects/database")
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 \"dbImage\": \"<string>\",\n \"environments\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"configurations\": {\n \"cpu\": 123,\n \"memory\": 123,\n \"storage\": 123,\n \"region\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"ha\": true,\n \"secondaryRegions\": [\n \"<string>\"\n ],\n \"tlsEnabled\": true,\n \"pgbouncerEnabled\": true,\n \"pgbouncerConfig\": {\n \"defaultPoolSize\": 50,\n \"maxDbConnections\": 250,\n \"maxDbClientConnections\": 2500,\n \"maxUserConnections\": 250,\n \"maxClientConn\": 5000,\n \"maxPreparedStatements\": 5000,\n \"serverLifetime\": 43230,\n \"serverIdleTimeout\": 43205\n },\n \"whitelistedIps\": [\n \"<string>\"\n ],\n \"deploy\": true,\n \"volumeId\": \"<string>\",\n \"linkedProjectIds\": [\n \"<string>\"\n ],\n \"public\": true\n}"
response = http.request(request)
puts response.read_body{
"message": "Operation performed successfully",
"data": {
"id": "6a81bed11470bfcd2a5dbcfa",
"name": "<string>",
"url": "<string>"
}
}{
"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.
Body
application/json
Required string length:
3 - 63Pattern:
^[a-fA-F0-9]{24}$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}$Environment id should be valid
Pattern:
^[a-fA-F0-9]{24}$SecondaryRegions must contain exactly 2 region ids
Required array length:
2 elementsPattern:
^[a-fA-F0-9]{24}$PgBouncer settings. Omit a field to keep its default.
Show child attributes
Show child attributes
Pattern:
^[a-fA-F0-9]{24}$Pattern:
^[a-fA-F0-9]{24}$Last modified on October 10, 2026
Was this page helpful?