/db-replicas (POST)

POST

/db-replicas

curl --request POST \
  --url https://example.com/api/v1/db-replicas \
  --header 'Content-Type: application/json' \
  --data '{ "primaryServerId": "example", "replicaServerId": "example", "mode": "logical" }'

Request Body ^required

Media type application/json

object

primaryServerId

required

string

replicaServerId

required

string

mode

Any of:

string

string

Allowed values: logical

string

string

Allowed values: streaming

Responses

201

Default Response

Media type application/json

object

id

required

string

primaryServerId

required

string

replicaServerId

required

Any of:

string

string

null

null

mode

required

string

status

required

string

slotName

required

Any of:

string

string

null

null

createdAt

required

string format: date-time

Example ^generated

{
  "id": "example",
  "primaryServerId": "example",
  "replicaServerId": "example",
  "mode": "example",
  "status": "example",
  "slotName": "example",
  "createdAt": "2026-04-15T12:00:00Z"
}

400

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}