Get Control Plane Info Endpoint
import requests
url = "https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}/control-plane"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}/control-plane', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}/control-plane \
--header 'Authorization: Bearer <token>'{
"can_change": true,
"count": 123,
"count_change": {
"allowed": true,
"mode": "",
"reason": "<string>"
},
"instance_type": "<string>",
"instance_type_change": {
"allowed": true,
"mode": "",
"reason": "<string>"
},
"supported_counts": [
123
],
"reason": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Hetzner Clusters
Get Control Plane Info Endpoint
GET
/
api
/
v1
/
clusters
/
hetzner
/
{cluster_id}
/
control-plane
Get Control Plane Info Endpoint
import requests
url = "https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}/control-plane"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}/control-plane', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}/control-plane \
--header 'Authorization: Bearer <token>'{
"can_change": true,
"count": 123,
"count_change": {
"allowed": true,
"mode": "",
"reason": "<string>"
},
"instance_type": "<string>",
"instance_type_change": {
"allowed": true,
"mode": "",
"reason": "<string>"
},
"supported_counts": [
123
],
"reason": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
Whether the controller COUNT can be changed. Retained for existing clients; prefer count_change, and read instance_type_change for the instance type, which has its own answer.
Whether the controller count can be changed. Changing the count still requires a stopped cluster.
Show child attributes
Show child attributes
Whether the instance type can be changed, and by which lane. A running cluster with at least three controllers can be resized live, one controller at a time.
Show child attributes
Show child attributes
Why the controller count cannot be changed. Retained for existing clients; prefer count_change.reason.