Add Node Group Endpoint

POST /api/v1/clusters/digitalocean/{cluster_id}/node-groups

Add Node Group Endpoint

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/digitalocean/{cluster_id}/node-groups"

payload = {
    "instance_type": "<string>",
    "name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "count": 123,
  "group_name": "<string>"
}

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

Query Parameters

wait · boolean · default: false

Body

application/json

instance_type · string · required

name · string · required

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.

count · integer · default: 1

labels · Labels · object

Show child attributes

taints · NodeTaint · object[]

Show child attributes

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

200

application/json

Successful Response

AddNodeGroupResult

AsyncWriteAcceptedResponse

count · integer · required

group_name · string · required