List available database engines
curl --request GET \
--url https://api.brimble.io/core/v1/projects/available-databases \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/projects/available-databases"
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/projects/available-databases', 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/available-databases",
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/projects/available-databases"
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/projects/available-databases")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/projects/available-databases")
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": "Available databases fetched successfully",
"data": [
{
"name": "mysql",
"image_url": "<string>",
"version": "<string>",
"envs": [
{
"value": "<string>",
"type": "<string>"
}
],
"is_available": true,
"is_default": true,
"backup_supported": true,
"restore_supported": true,
"pgbouncer_supported": true,
"pgvector_supported": true,
"manage_user": true,
"image": "<string>",
"free": true,
"erd": true,
"analytics": true,
"has_port": true,
"port": 123,
"volumePath": "<string>",
"protocol": "<string>",
"tls_enabled": true,
"ha": true,
"workbench": true,
"workbench_mode": "sql",
"password_mode": "provided",
"password_change_mode": "live",
"httpTitle": "<string>",
"httpSubtext": "<string>",
"params": {},
"recommendations": [
{
"cpu": "<string>",
"memory": "<string>",
"storage": "<string>"
}
],
"_id": "6a81bed11470bfcd2a5dbcfa",
"ha_image": "<string>",
"httpPort": 123,
"tls_protocol": "<string>",
"tls_params": {},
"connection": {
"user": true,
"database": true,
"protocol": "<string>",
"port": 123,
"authEnv": "<string>"
}
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Databases
List available database engines
API key scope: project.read
GET
/
v1
/
projects
/
available-databases
List available database engines
curl --request GET \
--url https://api.brimble.io/core/v1/projects/available-databases \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/projects/available-databases"
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/projects/available-databases', 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/available-databases",
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/projects/available-databases"
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/projects/available-databases")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/projects/available-databases")
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": "Available databases fetched successfully",
"data": [
{
"name": "mysql",
"image_url": "<string>",
"version": "<string>",
"envs": [
{
"value": "<string>",
"type": "<string>"
}
],
"is_available": true,
"is_default": true,
"backup_supported": true,
"restore_supported": true,
"pgbouncer_supported": true,
"pgvector_supported": true,
"manage_user": true,
"image": "<string>",
"free": true,
"erd": true,
"analytics": true,
"has_port": true,
"port": 123,
"volumePath": "<string>",
"protocol": "<string>",
"tls_enabled": true,
"ha": true,
"workbench": true,
"workbench_mode": "sql",
"password_mode": "provided",
"password_change_mode": "live",
"httpTitle": "<string>",
"httpSubtext": "<string>",
"params": {},
"recommendations": [
{
"cpu": "<string>",
"memory": "<string>",
"storage": "<string>"
}
],
"_id": "6a81bed11470bfcd2a5dbcfa",
"ha_image": "<string>",
"httpPort": 123,
"tls_protocol": "<string>",
"tls_params": {},
"connection": {
"user": true,
"database": true,
"protocol": "<string>",
"port": 123,
"authEnv": "<string>"
}
}
]
}{
"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.
Last modified on October 10, 2026
Was this page helpful?