Create an OVH cluster

POST /api/v1/clusters/ovh

Create an OVH cluster

Python

import requests

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

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

region · string · required

ssh_key_credential_id · string<uuid4> · required

availability_zones · string[]

3-AZ regions only: spread the cluster across these availability zones (e.g. eu-west-par-a/b/c). Control planes and etcd are distributed per role, workers per node group. Omitted leaves placement to OVH, which places the whole cluster in one zone. More than one zone requires at least 3 control planes for etcd quorum.

cni · enum<string> · default: flannel

Available options: flannel, calico, cilium

control_plane_count · integer · default: 1

control_plane_flavor_id · string · default: b3-16

criticality · enum<string> | null

Available options: production, staging, development, disposable

description · string | null

dhcp_end · string · default: 10.0.1.200

dhcp_start · string · default: 10.0.1.100

distribution · string · default: k3s

environment · string | null

Required string length: 1 - 50

etcd_flavor_id · string · default: b3-16

etcd_node_count · integer · default: 3

etcd_topology · string · default: stacked

external_cloud_provider · boolean · default: true

gateway_flavor_id · string · default: c3-4

gitops_branch · string · default: master

gitops_credential_name · string | null

gitops_repository · string | null

include_networking · boolean · default: true

kubernetes_version · string | null

network_vlan_id · integer · default: 0

node_groups · CreateOvhNodeGroupRequest · object[] | null

Show child attributes

subnet_cidr · string · default: 10.0.1.0/24

worker_count · integer · default: 1

worker_flavor_id · string · default: b3-16

Response

201

application/json

Cluster created successfully

cluster_id · string<uuid4> · required

name · string · required