{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"publicCloud.managedKubernetes.Flavor":{"type":"object","description":"A node flavor available for managed Kubernetes node pools in a region","properties":{"category":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.FlavorCategoryEnum"}],"description":"Category of the flavor","readOnly":true},"name":{"type":"string","description":"Flavor name, for example b3-8","readOnly":true},"resources":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.FlavorResources"}],"description":"Compute resources provided by the flavor","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.FlavorStatusEnum"}],"description":"Availability of the flavor for node pool creation","readOnly":true}}},"publicCloud.managedKubernetes.FlavorCategoryEnum":{"type":"string","description":"Resource profile a node flavor is optimized for","enum":["CPU_OPTIMIZED","DISCOVERY","GENERAL_PURPOSE","GPU","IOPS_OPTIMIZED","MEMORY_OPTIMIZED"]},"publicCloud.managedKubernetes.FlavorResources":{"type":"object","description":"Compute resources provided by a node flavor","properties":{"gpus":{"type":"integer","description":"Number of GPUs","readOnly":true},"memoryGiB":{"type":"integer","description":"Memory in GiB","readOnly":true},"vcpus":{"type":"integer","description":"Number of virtual CPUs","readOnly":true}}},"publicCloud.managedKubernetes.FlavorStatusEnum":{"type":"string","description":"Availability of a node flavor for node pool creation","enum":["AVAILABLE","UNAVAILABLE"]},"publicCloud.managedKubernetes.Plan":{"type":"object","description":"A plan available for managed Kubernetes clusters, with its control plane characteristics and limits","properties":{"controlPlane":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.PlanControlPlane"}],"description":"Control plane characteristics of the plan","readOnly":true},"limits":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.PlanLimits"}],"description":"Limits enforced by the plan","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.PlanNameEnum"}],"description":"Plan name","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.PlanStatusEnum"}],"description":"Availability of the plan for cluster creation","readOnly":true}}},"publicCloud.managedKubernetes.PlanControlPlane":{"type":"object","description":"Control plane characteristics of a managed Kubernetes plan","properties":{"etcd":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.PlanEtcd"}],"description":"Etcd characteristics of the control plane","readOnly":true}}},"publicCloud.managedKubernetes.PlanEtcd":{"type":"object","description":"etcd characteristics of a managed Kubernetes control plane","properties":{"dedicated":{"type":"boolean","description":"Whether etcd runs on storage dedicated to the cluster","readOnly":true},"storage":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.PlanEtcdStorage"}],"description":"Etcd storage quota","readOnly":true}}},"publicCloud.managedKubernetes.PlanEtcdStorage":{"type":"object","description":"etcd storage quota of a managed Kubernetes plan","properties":{"limit":{"type":"integer","description":"Storage quota, expressed in the given unit","readOnly":true},"unit":{"allOf":[{"$ref":"#/components/schemas/publicCloud.quota.QuotaUnitEnum"}],"description":"Unit of the storage quota","readOnly":true}}},"publicCloud.managedKubernetes.PlanLimits":{"type":"object","description":"Limits enforced by a managed Kubernetes plan","properties":{"maxNodes":{"type":"integer","description":"Maximum number of nodes allowed across the cluster","readOnly":true}}},"publicCloud.managedKubernetes.PlanNameEnum":{"type":"string","description":"Plan offered for managed Kubernetes clusters","enum":["FREE","STANDARD"]},"publicCloud.managedKubernetes.PlanStatusEnum":{"type":"string","description":"Availability of a plan for cluster creation","enum":["AVAILABLE","UNAVAILABLE"]},"publicCloud.managedKubernetes.Region":{"type":"object","description":"A region where managed Kubernetes clusters can be created, with its availability zones and the plans offered there","properties":{"availabilityZones":{"type":"array","description":"Availability zones in the region. Empty for a single-zone (mono-AZ) region.","items":{"type":"string"},"readOnly":true},"availablePlans":{"type":"array","description":"Plans that can be selected when creating a cluster in this region","items":{"$ref":"#/components/schemas/publicCloud.managedKubernetes.PlanNameEnum"},"readOnly":true},"name":{"type":"string","description":"Region identifier, for example EU-WEST-PAR","readOnly":true}}},"publicCloud.managedKubernetes.VersionCatalog":{"type":"object","description":"Kubernetes minor versions available for cluster creation, and the version applied when a creation request does not specify one","properties":{"availableVersions":{"type":"array","description":"Minor versions available for cluster creation, for example 1.34, newest first","items":{"$ref":"#/components/schemas/publicCloud.managedKubernetes.VersionReference"},"readOnly":true},"defaultVersion":{"type":"string","description":"Minor version applied when a creation request does not specify one, for example 1.34","readOnly":true}}},"publicCloud.managedKubernetes.VersionReference":{"type":"object","description":"A Kubernetes version with its support status","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedKubernetes.VersionStatusEnum"}],"description":"Support status of the version","readOnly":true},"version":{"type":"string","description":"Kubernetes version. Minor in the creation catalog, for example 1.34, full in the cluster update and upgrade lists, for example 1.34.2-1.","readOnly":true}}},"publicCloud.managedKubernetes.VersionStatusEnum":{"type":"string","description":"Support status of a Kubernetes version","enum":["END_OF_SUPPORT","SUPPORTED"]},"publicCloud.quota.QuotaUnitEnum":{"type":"string","description":"Unit of measurement for quota limits and usage","enum":["COUNT","GB","GiB","MB","MiB","TB","TiB"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/publicCloud/project/{projectId}/reference/managedKubernetes/flavor":{"get":{"operationId":"getKubernetesFlavors","summary":"List Kubernetes node flavors","description":"Returns the node flavors available for node pools in a region, with their category, resources and status. Requires a region.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"query","name":"region","description":"Region to list flavors for. Flavor availability varies by region. An unknown region returns 404.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedKubernetes.Flavor"}},"examples":{"Flavors in a region":{"value":[{"category":"GENERAL_PURPOSE","name":"b3-8","resources":{"gpus":0,"memoryGiB":8,"vcpus":2},"status":"AVAILABLE"},{"category":"CPU_OPTIMIZED","name":"c3-16","resources":{"gpus":0,"memoryGiB":16,"vcpus":8},"status":"AVAILABLE"},{"category":"DISCOVERY","name":"d2-8","resources":{"gpus":0,"memoryGiB":8,"vcpus":4},"status":"AVAILABLE"},{"category":"GPU","name":"h100-380","resources":{"gpus":1,"memoryGiB":380,"vcpus":30},"status":"AVAILABLE"},{"category":"MEMORY_OPTIMIZED","name":"r3-32","resources":{"gpus":0,"memoryGiB":32,"vcpus":4},"status":"UNAVAILABLE"}],"summary":"Node flavors with their resources and availability"}}}}}},"tags":["Reference"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Kubernetes Service","Service references@@@30"],["Public Cloud","Project Management","Service references","Managed Kubernetes@@@50"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/flavor\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/flavor\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:reference/managedKubernetes/flavor/get","required":true}]}},"/publicCloud/project/{projectId}/reference/managedKubernetes/plan":{"get":{"operationId":"getKubernetesPlans","summary":"List Kubernetes cluster plans","description":"Returns the plans available for cluster creation in a region, with their control plane characteristics and limits. Requires a region.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"query","name":"region","description":"Region to list plans for. Plan availability varies by region. An unknown region returns 404.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedKubernetes.Plan"}},"examples":{"Example":{"value":[{"controlPlane":{"etcd":{"dedicated":false,"storage":{"limit":400,"unit":"MiB"}}},"limits":{"maxNodes":100},"name":"FREE","status":"AVAILABLE"},{"controlPlane":{"etcd":{"dedicated":true,"storage":{"limit":8,"unit":"GiB"}}},"limits":{"maxNodes":500},"name":"STANDARD","status":"AVAILABLE"}],"summary":"Plans available for cluster creation."}}}}}},"tags":["Reference"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Kubernetes Service","Service references@@@20"],["Public Cloud","Project Management","Service references","Managed Kubernetes@@@40"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/plan\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/plan\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:reference/managedKubernetes/plan/get","required":true}]}},"/publicCloud/project/{projectId}/reference/managedKubernetes/region":{"get":{"operationId":"getKubernetesRegions","summary":"List Kubernetes cluster regions","description":"Returns the regions where a cluster can be created, with their availability zones and the plans offered there.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedKubernetes.Region"}},"examples":{"Example":{"value":[{"availabilityZones":[],"availablePlans":["FREE","STANDARD"],"name":"BHS5"},{"availabilityZones":["eu-west-par-a","eu-west-par-b","eu-west-par-c"],"availablePlans":["STANDARD"],"name":"EU-WEST-PAR"},{"availabilityZones":[],"availablePlans":["FREE","STANDARD"],"name":"GRA11"},{"availabilityZones":[],"availablePlans":["FREE","STANDARD"],"name":"SBG5"}],"summary":"Regions available for cluster creation."}}}}}},"tags":["Reference"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Kubernetes Service","Service references@@@10"],["Public Cloud","Project Management","Service references","Managed Kubernetes@@@30"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/region\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/region\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:reference/managedKubernetes/region/get","required":true}]}},"/publicCloud/project/{projectId}/reference/managedKubernetes/version":{"get":{"operationId":"getKubernetesVersions","summary":"List Kubernetes versions","description":"Returns the minor versions available for cluster creation, newest first, and the default version. Creation resolves a minor version to its latest patch.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedKubernetes.VersionCatalog"},"examples":{"Example":{"value":{"availableVersions":[{"status":"SUPPORTED","version":"1.34"},{"status":"SUPPORTED","version":"1.33"},{"status":"SUPPORTED","version":"1.32"},{"status":"END_OF_SUPPORT","version":"1.31"},{"status":"END_OF_SUPPORT","version":"1.30"}],"defaultVersion":"1.34"},"summary":"Creatable minor versions and the default applied when none is specified."}}}}}},"tags":["Reference"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Kubernetes Service","Service references@@@40"],["Public Cloud","Project Management","Service references","Managed Kubernetes@@@60"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/version\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/reference/managedKubernetes/version\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:reference/managedKubernetes/version/get","required":true}]}}},"tags":[{"name":"Reference","x-tag-expanded":false,"description":"Missing description"}]}