Skip to content
SYLVE

Update a Replication Policy

PUT
/cluster/replication/policies/{id}
curl --request PUT \
  --url https://sylve.lan:8181/api/cluster/replication/policies/1 \
  --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 } ] }'

Update one replication policy while preserving its ownership and transition state

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer

Replication Policy ID

Request Body

Section titled “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
Examplegenerated
{
  "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

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Policy, Guest, or Cluster Node Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

502

Section titled “502”

Leader Forwarding Failure

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

504

Section titled “504”

Leader Forwarding Timeout

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}