Update Database

PATCH

/databases/{database_id}

curl --request PATCH \
  --url https://api.mengi.cloud/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "storage_size_gb": 1, "cpu_request": 1, "memory_request_mb": 1, "max_connections": 1, "extensions": [ "example" ], "backup_enabled": true, "backup_schedule": "example", "backup_retention_days": 1, "external_access": true, "custom_domain": "example", "dns_credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "bunny_zone_id": 1 }'

Update configuration of a managed database instance.

Parameters

Path Parameters

database_id

required

Database Id

string format: uuid

Request Body ^required

Media type application/json

DatabaseUpdate

object

storage_size_gb

Any of:

integer

integer

null

null

cpu_request

Any of:

number

number

null

null

memory_request_mb

Any of:

integer

integer

null

null

max_connections

Any of:

integer

integer

null

null

extensions

Any of:

Array<string>

Array<string>

null

null

backup_enabled

Any of:

boolean

boolean

null

null

backup_schedule

Any of:

string

string

null

null

backup_retention_days

Any of:

integer

integer

null

null

external_access

Any of:

boolean

boolean

null

null

custom_domain

Any of:

string

string

null

null

dns_credential_id

Any of:

string

string format: uuid

null

null

bunny_zone_id

Any of:

integer

integer

null

null

Example ^generated

{
  "storage_size_gb": 1,
  "cpu_request": 1,
  "memory_request_mb": 1,
  "max_connections": 1,
  "extensions": [
    "example"
  ],
  "backup_enabled": true,
  "backup_schedule": "example",
  "backup_retention_days": 1,
  "external_access": true,
  "custom_domain": "example",
  "dns_credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "bunny_zone_id": 1
}

Responses

200

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

string format: uuid

null

null

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

number

null

null

memory_request_mb

Any of:

integer

integer

null

null

storage_size_gb

required

Storage Size Gb

integer

replicas

required

Replicas

integer

database_name

required

Database Name

string

max_connections

Any of:

integer

integer

null

null

extensions

Any of:

Array<string>

Array<string>

null

null

external_access

External Access

boolean

external_host

Any of:

string

string

null

null

custom_domain

Any of:

string

string

null

null

dns_credential_id

Any of:

string

string format: uuid

null

null

bunny_zone_id

Any of:

integer

integer

null

null

connection_host

Any of:

string

string

null

null

connection_port

Any of:

integer

integer

null

null

connection_secret_name

Any of:

string

string

null

null

backup_enabled

required

Backup Enabled

boolean

backup_schedule

Any of:

string

string

null

null

backup_retention_days

Any of:

integer

integer

null

null

git_path

Any of:

string

string

null

null

argocd_app_name

Any of:

string

string

null

null

replication_group_id

Any of:

string

string format: uuid

null

null

replication_role

Any of:

string

string

null

null

replication_source_id

Any of:

string

string format: uuid

null

null

replication_host

Any of:

string

string

null

null

replication_lag_bytes

Any of:

integer

integer

null

null

replication_status

Any of:

string

string

null

null

error_message

Any of:

string

string

null

null

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
}

422

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"
    }
  ]
}