Skip to content

Create Database

POST
/databases
curl --request POST \
--url https://api.mengi.cloud/databases \
--header 'Content-Type: application/json' \
--data '{ "cluster_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "engine": "postgresql", "engine_version": "example", "tier": "single", "cpu_request": 0.5, "memory_request_mb": 512, "storage_size_gb": 10, "database_name": "app", "max_connections": 100, "extensions": [ "example" ], "backup_enabled": true, "backup_schedule": "0 2 * * *", "backup_retention_days": 7, "external_access": false, "custom_domain": "example", "dns_credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "bunny_zone_id": 1 }'

Create a new managed database instance.

Media type application/json
DatabaseCreate
object
cluster_id
required
Cluster Id
string format: uuid
name
required
Name
string
engine
required
DatabaseEngine
string
Allowed values: postgresql mysql
engine_version
required
Engine Version
string
tier
DatabaseTier
string
default: single
Allowed values: single ha replicated
cpu_request
Any of:
number
memory_request_mb
Any of:
integer
storage_size_gb
Storage Size Gb
integer
default: 10
database_name
Database Name
string
default: app
max_connections
Any of:
integer
extensions
Any of:
Array<string>
backup_enabled
Backup Enabled
boolean
default: true
backup_schedule
Any of:
string
backup_retention_days
Any of:
integer
external_access
External Access
boolean
custom_domain
Any of:
string
dns_credential_id
Any of:
string format: uuid
bunny_zone_id
Any of:
integer

Successful Response

Media type application/json
DatabaseResponse
object
id
required
Id
string format: uuid
user_id
required
User Id
string format: uuid
organization_id
Any of:
string format: uuid
cluster_id
required
Cluster Id
string format: uuid
name
required
Name
string
engine
required
DatabaseEngine
string
Allowed values: postgresql mysql
engine_version
required
Engine Version
string
tier
required
DatabaseTier
string
Allowed values: single ha replicated
status
required
DatabaseStatus
string
Allowed values: pending provisioning running degraded upgrading error deleting
cpu_request
Any of:
number
memory_request_mb
Any of:
integer
storage_size_gb
required
Storage Size Gb
integer
replicas
required
Replicas
integer
database_name
required
Database Name
string
max_connections
Any of:
integer
extensions
Any of:
Array<string>
external_access
External Access
boolean
external_host
Any of:
string
custom_domain
Any of:
string
dns_credential_id
Any of:
string format: uuid
bunny_zone_id
Any of:
integer
connection_host
Any of:
string
connection_port
Any of:
integer
connection_secret_name
Any of:
string
backup_enabled
required
Backup Enabled
boolean
backup_schedule
Any of:
string
backup_retention_days
Any of:
integer
git_path
Any of:
string
argocd_app_name
Any of:
string
replication_group_id
Any of:
string format: uuid
replication_role
Any of:
string
replication_source_id
Any of:
string format: uuid
replication_host
Any of:
string
replication_lag_bytes
Any of:
integer
replication_status
Any of:
string
error_message
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
"engine": "postgresql",
"tier": "single",
"status": "pending",
"external_access": false
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}