Skip to main content
PUT
Update node-group autoscaling

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
group_name
string
required

Body

application/json
enabled
boolean
required
max_count
integer
default:100
min_count
integer
default:0

Response

Successful response

enabled
boolean
required
group_name
string
required
max_count
integer
required
min_count
integer
required
message
string

PUT only. What the write does to the group's node count, in words.

node_count
integer

PUT only. The group's node count when the write was made.

operation_id
string

PUT only. The operation applying the write; absent when none was created now (a stopped cluster, an operation already working on the cluster, or nothing to apply).

target_count
integer

PUT only. The node count the write moves the group to: max_count when the group had more nodes, min_count when it had fewer (while autoscaling is enabled), node_count otherwise. A group above max_count scales down through the guarded removal of its least busy nodes, each drained once the pipeline steps on it finish.