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
}
}
}{
"message": "The given data was invalid.",
"errors": {}
}{
"error": true,
"message": "<string>",
"trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z"
}Create a new database
Two options: Create a brand new managed PostgreSQL database (we handle everything!) or connect to your existing database. For managed databases, we’ll spin up a new PostgreSQL instance for you. For external databases, just provide your connection details.
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
}
}
}{
"message": "The given data was invalid.",
"errors": {}
}{
"error": true,
"message": "<string>",
"trace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
Enter token in format (Bearer )
Body
Database configuration
Database name
255"My New Database"
Type of database connection
managed_pg, external_db "managed_pg"
Database description
1000"Optional description"
Icon URL for the database
"database-icon.svg"
Hex color code for the database icon
^#[0-9A-Fa-f]{6}$"#60a5fa"
Database host (required for external_db)
"localhost"
Database port (required for external_db)
1 <= x <= 655355432
Database name (required for external_db)
"mydb"
Database username (required for external_db)
"user"
Database password (required for external_db)
"password"