Skip to main content
POST
Create an OVH cluster

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
bastion_allowed_ips
string[]

IPv4 addresses or CIDRs allowed to reach the bastion's SSH port. The platform's own egress addresses are always allowed in addition, so the platform can never be locked out. Omit (or send an empty list) to keep the bastion reachable from anywhere (key-only SSH, rate-limited). IPv6 and 0.0.0.0/0 entries are refused; at most 64 entries.

Maximum array length: 64
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>

Container network. Omitted resolves to cilium on kubeadm (the default distribution) and flannel on k3s.

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:kubeadm
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
gateway_model
enum<string>
default:s
Available options:
s,
m,
l,
xl,
2xl,
3xl
gitops_branch
string
default:master
gitops_credential_name
string | null
gitops_repository
string | null
gitops_provider
enum<string>
default:github

GitOps provider of the repository the cluster is bootstrapped onto. Omitted is github, where gitops_repository is owner/name. bitbucket_cloud names the repository by gitops_workspace and gitops_repo_slug (or gitops_repository as workspace/repo_slug) and binds it as a Bitbucket Cloud repository.

Available options:
github,
bitbucket_cloud
gitops_workspace
string | null

Bitbucket Cloud workspace of the GitOps repository. Only with gitops_provider bitbucket_cloud; provided together with gitops_repo_slug.

gitops_repo_slug
string | null

Bitbucket Cloud repository slug of the GitOps repository. Only with gitops_provider bitbucket_cloud; provided together with gitops_workspace.

include_networking
boolean
default:true
kubernetes_version
string | null
k3s_disabled_components
enum<string>[] | null

k3s packaged components to keep disabled (k3s --disable), for example ["traefik"] on a cluster that brings its own ingress. k3s distribution only: the list is rendered into the server config at install and re-asserted by the maintenance pass, so the entries stay off across restarts.

Available options:
coredns,
servicelb,
traefik,
local-storage,
metrics-server,
runtimes
network_vlan_id
integer
default:0
node_groups
CreateOvhNodeGroupRequest · object[] | null
subnet_cidr
string
default:10.0.1.0/24
worker_count
integer
default:1
worker_flavor_id
string
default:b3-16

Response

Cluster created successfully

cluster_id
string<uuid4>
required
name
string
required