Skip to content

Reveal Cluster Join Key

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

Reveal the enabled cluster key to a local administrator for node enrollment

Success

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

Unauthorized

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

Forbidden

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

Cluster join key unavailable

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

Internal Server Error

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