Skip to main content
POST
Create a database

Authorizations

x-brimble-key
string
header
required

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
name
string
required
Required string length: 3 - 63
dbImage
string
required
Pattern: ^[a-fA-F0-9]{24}$
environments
object[]
required
configurations
object
required
teamId
string

Team to act in. Omit for your personal workspace.

Pattern: ^[a-fA-F0-9]{24}$
environmentId
string

Environment id should be valid

Pattern: ^[a-fA-F0-9]{24}$
ha
boolean
secondaryRegions
string[]

SecondaryRegions must contain exactly 2 region ids

Required array length: 2 elements
Pattern: ^[a-fA-F0-9]{24}$
tlsEnabled
boolean
pgbouncerEnabled
boolean
pgbouncerConfig
object | null

PgBouncer settings. Omit a field to keep its default.

whitelistedIps
string[]
deploy
boolean
volumeId
string
Pattern: ^[a-fA-F0-9]{24}$
linkedProjectIds
string[]
Pattern: ^[a-fA-F0-9]{24}$
public
boolean | null

Response

Operation performed successfully

message
string
required
Example:

"Operation performed successfully"

data
object
required
Last modified on October 10, 2026