Skip to main content
GET
Read control-plane sizing

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Response

Successful response

can_change
boolean
required

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.

count
integer
required
count_change
ControlPlaneChangeCapability · object
required

Whether the controller count can be changed. Changing the count still requires a stopped cluster.

instance_type
string
required
instance_type_change
ControlPlaneChangeCapability · object
required

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.

supported_counts
integer[]
required
reason
string | null

Why the controller count cannot be changed. Retained for existing clients; prefer count_change.reason.