Update Instance Type Endpoint

PUT /api/v1/clusters/hetzner/{cluster_id}/node-groups/{group_name}/instance-type

Update Instance Type Endpoint

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/hetzner/{cluster_id}/node-groups/{group_name}/instance-type"

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

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

print(response.text)

200

{
  "group_name": "<string>",
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated": 123
}

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

instance_type · string · required

Response

200

application/json

Successful Response

UpdateNodeGroupInstanceTypeResult

AsyncWriteAcceptedResponse

group_name · string · required

operation_id · string<uuid> | null · required

Operation carrying the cloud resize; poll it to know when the group is back. Null when the write scheduled no work: a stopped cluster applies the new type on start, a group still being created is left to the create, and a group already covered by an active write operation is left to that operation.

updated · integer · required