Create an UpCloud cluster

POST /api/v1/clusters/upcloud

Create an UpCloud cluster

Python

import requests

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

payload = {
    "credential_id": "<string>",
    "name": "<string>",
    "ssh_key_credential_id": "<string>",
    "zone": "<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

name · string · required

ssh_key_credential_id · string<uuid4> · required

zone · string · required

bastion_plan · string · default: 1xCPU-1GB

cni · enum<string> · default: flannel

Available options: flannel, calico, cilium

control_plane_count · integer · default: 1

control_plane_plan · string · default: 2xCPU-4GB

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_plan · string · default: 2xCPU-4GB

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 | null

node_groups · CreateUpcloudNodeGroupRequest · object[] | null

Show child attributes

worker_count · integer · default: 1

worker_plan · string · default: 2xCPU-4GB

Response

201

application/json

Cluster created successfully

cluster_id · string<uuid4> · required

name · string · required