Skip to content
SYLVE

Force Remove Peer

POST
/cluster/remove-node/force
curl --request POST \
  --url https://sylve.lan:8181/api/cluster/remove-node/force \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "nodeId": "example", "targetExternallyFenced": true }'

Remove an externally fenced, unavailable peer without contacting it

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Force Remove Peer Request

Media typeapplication/json
object
nodeId
string
targetExternallyFenced
boolean
Examplegenerated
{
  "nodeId": "example",
  "targetExternallyFenced": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
cleanupAcknowledged
boolean
membershipRemoved
boolean
status
object
attempts
integer
enabled
boolean
lastError
string
leaderIp
string
leaveId
string
localNodeId
string
phase
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "cleanupAcknowledged": true,
    "membershipRemoved": true,
    "status": {
      "attempts": 1,
      "enabled": true,
      "lastError": "example",
      "leaderIp": "example",
      "leaveId": "example",
      "localNodeId": "example",
      "phase": "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”

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
object
dependencies
Array<object>
object
id
string
kind
string
name
string
role
string
state
string
nodeId
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "dependencies": [
      {
        "id": "example",
        "kind": "example",
        "name": "example",
        "role": "example",
        "state": "example"
      }
    ],
    "nodeId": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Consensus unavailable

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