Remove Peer

POST

/cluster/remove-node

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

Ask an online peer to fence local work, leave Raft, and clear its cluster state

Authorizations

• BearerAuth

Request Body

Remove Peer Request

Media typeapplication/json

object

nodeId

required

string

Example^generated

{
  "nodeId": "example"
}

Responses

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

Example^generated

{
  "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

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"
}

409

Peer owns cluster resources

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

Example^generated

{
  "data": {
    "dependencies": [
      {
        "id": "example",
        "kind": "example",
        "name": "example",
        "role": "example",
        "state": "example"
      }
    ],
    "nodeId": "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"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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