Get Cluster

GET

/cluster

curl --request GET \
  --url https://sylve.lan:8181/api/cluster \
  --header 'Authorization: <Authorization>'

Get cluster details with information about RAFT nodes too

Authorizations

• BearerAuth

Responses

200

Success

Media typeapplication/json

object

data

object

cluster

object

enabled

boolean

id

integer

raftBootstrap

boolean

raftIP

string

raftPort

integer

leaderAddress

string

leaderId

string

nodeId

string

nodes

Array<object>

object

address

string

guestIDs

Array<integer>

id

string

isLeader

boolean

suffrage

string

partial

boolean

error

string

message

string

status

string

Example^generated

{
  "data": {
    "cluster": {
      "enabled": true,
      "id": 1,
      "raftBootstrap": true,
      "raftIP": "example",
      "raftPort": 1
    },
    "leaderAddress": "example",
    "leaderId": "example",
    "nodeId": "example",
    "nodes": [
      {
        "address": "example",
        "guestIDs": [
          1
        ],
        "id": "example",
        "isLeader": true,
        "suffrage": "example"
      }
    ],
    "partial": true
  },
  "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"
}

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