List Replication

GET

/databases/replication-groups

curl --request GET \
  --url 'https://api.mengi.cloud/databases/replication-groups?skip=0&limit=50'

List replication groups accessible to the user (owned or via org).

Parameters

Query Parameters

skip

Skip

integer

0

limit

Limit

integer

default: 50 >= 1 <= 100

Responses

200

Successful Response

Media typeapplication/json

ReplicationGroupListResponse

object

groups

required

Groups

Array<object>

ReplicationGroupResponse

object

id

required

Id

string format: uuid

name

required

Name

string

engine

required

DatabaseEngine

string

Allowed values: postgresql mysql

primary_instance_id

Any of:

string

string format: uuid

null

null

instances

required

Instances

Array<object>

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

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

fee_exempt_until

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

total

required

Total

integer

Example

{
  "groups": [
    {
      "engine": "postgresql",
      "instances": [
        {
          "engine": "postgresql",
          "tier": "single",
          "status": "pending",
          "external_access": false
        }
      ]
    }
  ]
}

422

Validation Error

Media typeapplication/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"
    }
  ]
}