Skip to main content
POST
Error
A valid request URL is required to generate request examples
{
  "message": "Database created successfully",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "database": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "connection_type": "<string>",
    "connection_db_name": "<string>",
    "status": "<string>",
    "connection_summary": {
      "type": "<string>",
      "host": "<string>",
      "database": "<string>",
      "can_connect": true
    }
  }
}

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