Create a Hetzner cluster

POST /api/v1/clusters/hetzner

Create a Hetzner cluster

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/hetzner"

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

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

print(response.text)

201

{
  "cluster_id": "<string>",
  "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

Body

application/json

credential_id · string<uuid4> · required

location · string · required

Minimum string length: 1

name · string · required

Minimum string length: 1

bastion_server_type · string

Omit to let the platform pick the cheapest x86 type the target location can currently provision that meets the role's minimum size.

Minimum string length: 1

cni · enum<string> · default: flannel

Available options: flannel, calico, cilium

control_plane_count · integer · default: 1

Required range: 1 <= x <= 5

control_plane_server_type · string

Omit to let the platform pick the cheapest x86 type the target location can currently provision that meets the role's minimum size.

Minimum string length: 1

criticality · enum<string> | null

Available options: production, staging, development, disposable

description · string | null

distribution · string · default: k3s

environment · string | null

Required string length: 1 - 50

etcd_node_count · integer · default: 3

etcd_server_type · string

Omit to let the platform pick the cheapest x86 type the target location can currently provision that meets the role's minimum size.

etcd_topology · string · default: stacked

external_cloud_provider · boolean · default: true

gitops_branch · string · default: master

gitops_credential_name · string | null

gitops_repository · string | null

include_networking · boolean · default: true

kubernetes_version · string | null

network_ip_range · string · default: 10.0.0.0/16

node_groups · CreateNodeGroupRequest · object[] | null

Show child attributes

ssh_key_credential_id · string<uuid4> | null

ssh_key_credential_ids · string<uuid4>[]

subnet_range · string · default: 10.0.1.0/24

worker_count · integer · default: 1

Required range: 0 <= x <= 50

worker_server_type · string

Omit to let the platform pick the cheapest x86 type the target location can currently provision that meets the role's minimum size.

Minimum string length: 1

Response

201

application/json

Cluster created successfully

cluster_id · string<uuid4> · required

name · string · required