Skip to main content
PUT
Resize control-plane nodes

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Headers

X-Ankra-CSRF
string
required

Must match the ankra_csrf browser cookie.

Path Parameters

cluster_id
string<uuid>
required

Body

application/json
instance_type
string
required

The new instance type for every node in the group. Changing it power-cycles each node, so the nodes are rolled in bounded lanes and each is drained before it goes down.

force_drain
boolean
default:false

Bypass PodDisruptionBudgets when draining each node before it is power-cycled. Off by default: a budget is a workload owner's stated availability requirement.

Response

Successful response

mode
enum<string>
required

Which lane the request took: 'offline' rewrote a stopped cluster's plan, 'rolling' is the live one-controller-at-a-time path on a running cluster. It describes the lane, not whether work was dispatched - read operation_id for that.

Available options:
offline,
rolling
new_instance_type
string
required
previous_instance_type
string
required
updated
integer
required
operation_id
string<uuid> | null

The operation to poll, when the request dispatched one. Null whenever nothing was dispatched: on the offline lane, which applies the new size at the next cluster start (its own operation), and on either lane when the control planes already run the requested type (updated is 0). Decide whether to poll by testing operation_id for null, not by reading mode.