Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Enter token in format (Bearer )

Body

application/json

Database configuration

name
string
required

Database name

Maximum string length: 255
Example:

"My New Database"

connection_type
enum<string>
required

Type of database connection

Available options:
managed_pg,
external_db
Example:

"managed_pg"

description
string | null

Database description

Maximum string length: 1000
Example:

"Optional description"

icon_url
string | null

Icon URL for the database

Example:

"database-icon.svg"

icon_color
string | null

Hex color code for the database icon

Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#60a5fa"

connection_host
string | null

Database host (required for external_db)

Example:

"localhost"

connection_port
integer | null

Database port (required for external_db)

Required range: 1 <= x <= 65535
Example:

5432

connection_db_name
string | null

Database name (required for external_db)

Example:

"mydb"

connection_username
string | null

Database username (required for external_db)

Example:

"user"

connection_password
string | null

Database password (required for external_db)

Example:

"password"

Response

Database created successfully

message
string
Example:

"Database created successfully"

transaction_id
string<uuid>
database
object