Skip to main content
POST
Add node group

Authorizations

Authorization
string
header
required

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

Path Parameters

cluster_id
string<uuid>
required

Query Parameters

wait
boolean
default:false

Run the change in the request and answer its result. Off by default: the change runs in the background and the call answers 202.

Body

application/json
instance_type
string
required
name
string
required
swap_gibibytes
integer

OVH k3s clusters on Kubernetes v1.36 or newer only: size in GiB of the encrypted swap every node the group ever creates is built with, 1 to 1024. Refused on kubeadm clusters, older releases and other providers.

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

Kubelet swap behaviour of those nodes. Defaults to LimitedSwap when swap_gibibytes is set; refused without it.

Available options:
LimitedSwap
availability_zone
string

OVH 3-AZ regions only: pin every node of this group to one availability zone (e.g. eu-west-par-b). Omitted spreads the group across the cluster's zones.

zone
string

UpCloud multi-zone clusters only: pin every node of this group to one zone of the cluster's pool. Omitted spreads the group across the pool.

count
integer
default:1
labels
Labels · object
taints
NodeTaint · object[]
user_data
string

OVH only: opaque cloud-init user data applied verbatim at first boot by every instance the group ever creates, replacements included. Max 65535 bytes.

Response

The change's result (wait=true)

count
integer
required
group_name
string
required