Create a Replication Policy

POST

/cluster/replication/policies

curl --request POST \
  --url https://sylve.lan:8181/api/cluster/replication/policies \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "crashRecovery": true, "crashRestartMax": 1, "cronExpr": "example", "description": "example", "enabled": true, "failbackMode": "example", "failoverMode": "example", "guestId": 1, "guestType": "example", "name": "example", "poolCapacityPct": 1, "poolHealthCheck": true, "sourceMode": "example", "sourceNodeId": "example", "targets": [ { "nodeId": "example", "weight": 1 } ] }'

Create a replication policy for a VM or jail

Authorizations

• BearerAuth

Request Body

Replication Policy Request

Media typeapplication/json

object

crashRecovery

boolean

crashRestartMax

integer

cronExpr

string

description

string

enabled

boolean

failbackMode

string

failoverMode

string

guestId

required

integer

guestType

required

string

name

required

string

>= 2 characters

poolCapacityPct

integer

poolHealthCheck

boolean

sourceMode

string

sourceNodeId

string

targets

required

Array<object>

object

nodeId

required

string

weight

integer

Example^generated

{
  "crashRecovery": true,
  "crashRestartMax": 1,
  "cronExpr": "example",
  "description": "example",
  "enabled": true,
  "failbackMode": "example",
  "failoverMode": "example",
  "guestId": 1,
  "guestType": "example",
  "name": "example",
  "poolCapacityPct": 1,
  "poolHealthCheck": true,
  "sourceMode": "example",
  "sourceNodeId": "example",
  "targets": [
    {
      "nodeId": "example",
      "weight": 1
    }
  ]
}

Responses

201

Created

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Guest or Cluster Node Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

502

Leader Forwarding Failure

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

504

Leader Forwarding Timeout

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}