Skip to content

Managed Kubernetes

All operations require authentication.

4 operationsv2/publicCloud/project
Agent setup

List Kubernetes cluster regionsBeta

GET
/v2/publicCloud/project/{projectId}/reference/managedKubernetes/region

Returns the regions where a cluster can be created, with their availability zones and the plans offered there.

Path parameters

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Region[]successful operation
availabilityZones
read-only
string[]

Availability zones in the region. Empty for a single-zone (mono-AZ) region.

availablePlans
read-only
PlanNameEnum[]

Plans that can be selected when creating a cluster in this region

ValuesFREESTANDARD
name
read-only
string

Region identifier, for example EU-WEST-PAR

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/managedKubernetes/region \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "availabilityZones": [ "string" ], "availablePlans": [ "FREE" ], "name": "string" }]

List Kubernetes cluster plansBeta

GET
/v2/publicCloud/project/{projectId}/reference/managedKubernetes/plan

Returns the plans available for cluster creation in a region, with their control plane characteristics and limits. Requires a region.

Path parameters

projectId
required
string

Project ID

Query parameters

region
required
string

Region to list plans for. Plan availability varies by region. An unknown region returns 404.

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Plan[]successful operation
controlPlane
read-only
PlanControlPlane

Control plane characteristics of the plan

limits
read-only
PlanLimits

Limits enforced by the plan

name
read-only
PlanNameEnum

Plan name

ValuesFREESTANDARD
status
read-only
PlanStatusEnum

Availability of the plan for cluster creation

ValuesAVAILABLEUNAVAILABLE

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/managedKubernetes/plan \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "controlPlane": { "etcd": { "dedicated": true, "storage": { "limit": 0, "unit": "COUNT" } } }, "limits": { "maxNodes": 0 }, "name": "FREE", "status": "AVAILABLE" }]

List Kubernetes node flavorsBeta

GET
/v2/publicCloud/project/{projectId}/reference/managedKubernetes/flavor

Returns the node flavors available for node pools in a region, with their category, resources and status. Requires a region.

Path parameters

projectId
required
string

Project ID

Query parameters

region
required
string

Region to list flavors for. Flavor availability varies by region. An unknown region returns 404.

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Flavor[]successful operation
category
read-only
FlavorCategoryEnum

Category of the flavor

ValuesCPU_OPTIMIZEDDISCOVERYGENERAL_PURPOSEGPUIOPS_OPTIMIZEDMEMORY_OPTIMIZED
name
read-only
string

Flavor name, for example b3-8

resources
read-only
FlavorResources

Compute resources provided by the flavor

status
read-only
FlavorStatusEnum

Availability of the flavor for node pool creation

ValuesAVAILABLEUNAVAILABLE

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/managedKubernetes/flavor \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "category": "CPU_OPTIMIZED", "name": "string", "resources": { "gpus": 0, "memoryGiB": 0, "vcpus": 0 }, "status": "AVAILABLE" }]

List Kubernetes versionsBeta

GET
/v2/publicCloud/project/{projectId}/reference/managedKubernetes/version

Returns the minor versions available for cluster creation, newest first, and the default version. Creation resolves a minor version to its latest patch.

Path parameters

projectId
required
string

Project ID

Response

200VersionCatalogsuccessful operation
availableVersions
read-only
VersionReference[]

Minor versions available for cluster creation, for example 1.34, newest first

defaultVersion
read-only
string

Minor version applied when a creation request does not specify one, for example 1.34

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/managedKubernetes/version \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "availableVersions": [ { "status": "END_OF_SUPPORT", "version": "string" } ], "defaultVersion": "string"}