Skip to main content
POST
/
api
/
v1
/
clusters
/
ovh
Create an OVH cluster
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)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credential_id: '<string>',
name: '<string>',
region: '<string>',
ssh_key_credential_id: '<string>'
})
};

fetch('https://platform.ankra.app/api/v1/clusters/ovh', 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/ovh \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credential_id": "<string>",
"name": "<string>",
"region": "<string>",
"ssh_key_credential_id": "<string>"
}
'
{
  "cluster_id": "<string>",
  "name": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<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
cni
enum<string>
default:flannel
Available options:
flannel,
calico,
cilium
control_plane_count
integer
default:1
control_plane_flavor_id
string
default:b2-15
description
string | null
dhcp_end
string
default:10.0.1.200
dhcp_start
string
default:10.0.1.100
distribution
string
default:k3s
etcd_flavor_id
string
default:b2-15
etcd_node_count
integer
default:3
etcd_topology
string
default:stacked
external_cloud_provider
boolean
default:true
gateway_flavor_id
string
default:b2-7
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
subnet_cidr
string
default:10.0.1.0/24
worker_count
integer
default:1
worker_flavor_id
string
default:b2-15

Response

Cluster created successfully

cluster_id
string<uuid4>
required
name
string
required