Skip to main content
PUT
Scale node group

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

cluster_id
string<uuid>
required
group_name
string
required

Query Parameters

wait
boolean
default:false

Body

application/json
count
integer
required
force_drain
boolean
default:false

Scale-down only. Remove the workers this request takes away without honouring PodDisruptionBudgets: each is drained the way a cluster teardown drains it and removed even when its drain is refused or its node cannot be reached. Off by default: a scale-down drains the removed workers one at a time through their budgets and keeps a worker whose drain is refused.

Response

Successful Response

dispatch
enum<string>
required

What the write did about the operation that applies it. started: operation_id names it, created in the same transaction as the write. deferred: the change is stored but no operation was started for it now; dispatch_reason says why and what applies it instead (the reconcile loop once a running operation has finished, or the cluster's next start). none: the write left nothing for an operation to apply (a scale to the group's current count, a removal on a stopped cluster, which the write applies to the group's records itself).

Available options:
started,
deferred,
none
group_name
string
required
new_count
integer
required
operation_id
string<uuid> | null
required

The operation that applies this change, created in the same transaction as the write: poll it on /api/v1/org/executions/{execution_id} to know when the nodes have moved. Null when the write started none; dispatch says why.

previous_count
integer
required
dispatch_reason
string

Why no operation was started (deferred, none), or what a started operation leaves to the reconcile loop (an offline cluster's agent work). Absent when a started operation carries the whole change.