Skip to main content
POST
/
api
/
v1
/
clusters
/
upcloud
Create an UpCloud cluster
import requests

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

payload = {
    "name": "<string>",
    "credential_id": "<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)
{
  "cluster_id": "<string>",
  "name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ankra.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
authorization
string | null

Body

application/json
​
name
string
required
​
credential_id
string<uuid4>
required
​
ssh_key_credential_id
string<uuid4>
required
​
zone
string
required
​
description
string | null
​
network_ip_range
string
default:10.0.0.0/24
​
bastion_plan
string
default:1xCPU-1GB
​
control_plane_count
integer
default:1
​
control_plane_plan
string
default:2xCPU-4GB
​
worker_count
integer
default:1
​
worker_plan
string
default:2xCPU-4GB
​
distribution
string
default:k3s
​
kubernetes_version
string | null
​
node_groups
CreateUpcloudNodeGroupRequest · object[] | null

Response

Cluster created successfully

​
cluster_id
string<uuid4>
required
​
name
string
required