Create Ankra Cloud cluster

import requests

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

payload = {
    "bastion_plan": "c1-2",
    "control_plane_plan": "c2-4",
    "credential_id": "11111111-2222-4333-8444-555555555555",
    "name": "ankra-prod",
    "ssh_key_credential_id": "99999999-8888-4777-8666-555555555555",
    "zone": "de-fsn1"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bastion_plan: 'c1-2',
    control_plane_plan: 'c2-4',
    credential_id: '11111111-2222-4333-8444-555555555555',
    name: 'ankra-prod',
    ssh_key_credential_id: '99999999-8888-4777-8666-555555555555',
    zone: 'de-fsn1'
  })
};

fetch('https://platform.ankra.app/api/v1/clusters/ankracloud', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/clusters/ankracloud \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bastion_plan": "c1-2",
  "control_plane_plan": "c2-4",
  "credential_id": "11111111-2222-4333-8444-555555555555",
  "name": "ankra-prod",
  "ssh_key_credential_id": "99999999-8888-4777-8666-555555555555",
  "zone": "de-fsn1"
}
'

{
  "cluster_id": "11111111-2222-4333-8444-555555555555",
  "name": "ankra-prod"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

Ankra Cloud Clusters

Create Ankra Cloud cluster

Bearer PAT authentication; RBAC permission clusters. RBAC permission clusters.create. Creates a self-managed kubeadm / k3s cluster on Ankra Cloud servers: a private RFC 1918 network (network_ip_range, or an adopted private_network_id), a router with NAT for IPv4 egress, a bastion with a public IPv4 and the cluster nodes on the private network only. Plans replace instance types (bastion_plan, control_plane_plan, worker_plan, etcd_plan; node groups keep instance_type), templateis the OS image (default debian-13). The preflight runs first and the first failing item is the refusal. kubeadm requires Cilium; the ankra-cloud-ccm is always installed.bastion_portis accepted for contract symmetry and ignored: the bastion listens on 22. Answers 404 while the organisation'sankra_cloud_provider` feature flag is off.

POST

api

clusters

ankracloud

Create Ankra Cloud cluster

import requests

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

payload = {
    "bastion_plan": "c1-2",
    "control_plane_plan": "c2-4",
    "credential_id": "11111111-2222-4333-8444-555555555555",
    "name": "ankra-prod",
    "ssh_key_credential_id": "99999999-8888-4777-8666-555555555555",
    "zone": "de-fsn1"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bastion_plan: 'c1-2',
    control_plane_plan: 'c2-4',
    credential_id: '11111111-2222-4333-8444-555555555555',
    name: 'ankra-prod',
    ssh_key_credential_id: '99999999-8888-4777-8666-555555555555',
    zone: 'de-fsn1'
  })
};

fetch('https://platform.ankra.app/api/v1/clusters/ankracloud', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/clusters/ankracloud \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bastion_plan": "c1-2",
  "control_plane_plan": "c2-4",
  "credential_id": "11111111-2222-4333-8444-555555555555",
  "name": "ankra-prod",
  "ssh_key_credential_id": "99999999-8888-4777-8666-555555555555",
  "zone": "de-fsn1"
}
'

{
  "cluster_id": "11111111-2222-4333-8444-555555555555",
  "name": "ankra-prod"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": "Cluster not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Cluster not found"
}

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.

Body

application/json

bastion_plan

string

required

control_plane_plan

string

required

credential_id

string<uuid>

required

name

string

required

ssh_key_credential_id

string<uuid>

required

zone

string

required

Ankra Cloud zone (GET /clusters/ankracloud/zones); every server of the cluster is placed there.

bastion_allowed_ips

string[]

IPv4/IPv6 addresses or CIDRs allowed to SSH to the bastion; empty allows any source.

bastion_port

integer

default:22

Accepted for contract symmetry with the managed-gateway providers and ignored: the bastion listens on 22.

cni

enum<string>

default:cilium

kubeadm supports only cilium on Ankra Cloud.

Available options:

flannel,

calico,

cilium

cni_features

object

Show child attributes

control_plane_count

integer

default:1

Required range: 1 <= x <= 9

criticality

string | null

description

string | null

distribution

enum<string>

default:kubeadm

Available options:

k3s,

kubeadm

environment

string | null

etcd_node_count

integer

default:3

etcd_plan

string

default:""

Required for an external etcd topology.

etcd_topology

enum<string>

default:stacked

Available options:

stacked,

external

external_cloud_provider

boolean

default:true

gitops_branch

string

default:master

gitops_credential_name

string

default:""

gitops_repository

string

default:""

include_dns

boolean

default:true

include_networking

boolean

default:true

k3s_disabled_components

string[] | null

kubernetes_version

string | null

network_ip_range

string | null

RFC 1918 CIDR (/16 through /29) of the private network Ankra creates; omitted derives one per cluster.

node_groups

object[]

Show child attributes

private_network_id

string | null

Adopts an existing private network in the zone; mutually exclusive with network_ip_range. An adopted network is never deleted by the cluster.

retention_policy

enum<string>

default:retain

Available options:

delete,

retain

runtime_credential_id

string<uuid> | null

Credential the running cluster's cloud-controller-manager and CSI use; omitted reuses credential_id.

template

string

default:debian-13

Public OS template id (GET /clusters/ankracloud/templates).

worker_count

integer

default:1

Required range: 0 <= x <= 100

worker_plan

string

default:""

Required when worker_count is above zero and no node_groups are given.

Response

Successful response

cluster_id

string<uuid>

required

name

string

required

API reference

Endpoints

Create Ankra Cloud cluster

Authorizations

Headers

Body

Response