Skip to main content
POST
/
api
/
v1
/
databases
Create database
curl --request POST \
  --url https://api.example.com/api/v1/databases
Creates a new PostgreSQL database with its own user, password, and PgBouncer pool entry.
Database names must match ^[a-z][a-z0-9-]{1,48}[a-z0-9]$ — lowercase letters, numbers, and hyphens, 3-50 characters.

​
Request body

FieldTypeRequiredDescription
namestringYesDatabase identifier (becomes DB name and username)
displayNamestringYesHuman-friendly label
{
  "name": "my-app",
  "displayName": "My Application"
}

​
Response

201 Created
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "my-app",
  "displayName": "My Application",
  "host": "13.61.204.171",
  "port": 6432,
  "dbName": "my_app",
  "username": "my_app",
  "password": "generated-secret-token",
  "status": "active",
  "sizeBytes": 0,
  "createdAt": "2026-03-19T12:00:00.000Z"
}

​
Errors

StatusCodeDescription
400INVALID_NAMEName doesn’t match the required pattern
409DATABASE_EXISTSA database with this name already exists