Skip to content
SYLVE

Leave Cluster

DELETE
/cluster/reset-node
curl --request DELETE \
  --url https://sylve.lan:8181/api/cluster/reset-node \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "retainGuests": true }'

Safely remove this node from Raft and clear its local cluster state. Registered guests block a multi-node leave by default. Set retainGuests=true to keep local VM and jail registrations and release their cluster ID claims after membership removal. Other dependencies still block.

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Optional leave options

Media typeapplication/json
object
retainGuests
boolean
Examplegenerated
{
  "retainGuests": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
cleanupAcknowledged
boolean
membershipRemoved
boolean
retainedGuests
Array<object>
object
guestId
integer
guestType
string
name
string
nodeId
string
recordId
integer
status
object
attempts
integer
enabled
boolean
lastError
string
leaderIp
string
leaveId
string
localNodeId
string
phase
string
retainGuests
boolean
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "cleanupAcknowledged": true,
    "membershipRemoved": true,
    "retainedGuests": [
      {
        "guestId": 1,
        "guestType": "example",
        "name": "example",
        "nodeId": "example",
        "recordId": 1
      }
    ],
    "status": {
      "attempts": 1,
      "enabled": true,
      "lastError": "example",
      "leaderIp": "example",
      "leaveId": "example",
      "localNodeId": "example",
      "phase": "example",
      "retainGuests": true
    }
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

202

Section titled “202”

Leave pending

Media typeapplication/json
object
data
object
cleanupAcknowledged
boolean
membershipRemoved
boolean
retainedGuests
Array<object>
object
guestId
integer
guestType
string
name
string
nodeId
string
recordId
integer
status
object
attempts
integer
enabled
boolean
lastError
string
leaderIp
string
leaveId
string
localNodeId
string
phase
string
retainGuests
boolean
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "cleanupAcknowledged": true,
    "membershipRemoved": true,
    "retainedGuests": [
      {
        "guestId": 1,
        "guestType": "example",
        "name": "example",
        "nodeId": "example",
        "recordId": 1
      }
    ],
    "status": {
      "attempts": 1,
      "enabled": true,
      "lastError": "example",
      "leaderIp": "example",
      "leaveId": "example",
      "localNodeId": "example",
      "phase": "example",
      "retainGuests": true
    }
  },
  "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"
}

409

Section titled “409”

Leave conflict

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

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