Skip to main content
PUT
Update node-group host config

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
swap_gibibytes
integer
required

Size in GiB of the encrypted swap the group's new nodes are built with, 1 to 1024. 0 clears the setting.

Required range: 0 <= x <= 1024
swap_behavior
enum<string>

Kubelet swap behaviour of those nodes. Defaults to LimitedSwap when a size is set; refused with 0.

Available options:
LimitedSwap

Response

Successful response

group_name
string
required
swap_gibibytes
integer
required

The size now set, 0 when the setting was cleared.

existing_workers
integer
required

Workers already in the group, none of which were changed.

message
string
required

Plain statement of what changed, and that existing nodes did not.

swap_behavior
string

The behaviour now set. Omitted when the setting was cleared.