OVH Cloud Cloud API
The Cloud API from OVH Cloud — 469 operation(s) for cloud.
OpenAPI Specification
openapi: 3.0.0
info:
title: OVH OVHcloud API specification Cloud API
description: Specification for OVHcloud API
version: '1.0'
contact:
name: OVH
email: api@ml.ovh.net
servers:
- url: https://api.us.ovhcloud.com/v1
tags:
- name: Cloud
paths:
/cloud/order:
get:
summary: OVH Cloud Get all cloud pending orders
security:
- oAuth2AuthCode: []
parameters:
- in: query
name: planCode
description: Order plan code
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/cloud.order.Order'
x-badges:
- color: green
label: Stable production 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(\"/cloud/order\")\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(\"/cloud/order\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: account:apiovh:cloud/order/get
required: true
tags:
- Cloud
/cloud/order/rule/availability:
get:
summary: OVH Cloud Get product availability
security:
- oAuth2AuthCode: []
parameters:
- in: query
name: addonFamily
description: Addon family filter
schema:
type: string
- in: query
name: ovhSubsidiary
description: OVH subsidiary
required: true
schema:
$ref: '#/components/schemas/nichandle.OvhSubsidiaryEnum'
- in: query
name: planCode
description: Plan code filter
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/cloud.order.rule.Availability'
x-badges:
- color: green
label: Stable production 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(\"/cloud/order/rule/availability\")\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(\"/cloud/order/rule/availability\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: account:apiovh:cloud/order/rule/availability/get
required: true
tags:
- Cloud
/cloud/order/rule/instanceCategory:
get:
summary: OVH Cloud Get instance categories
security:
- oAuth2AuthCode: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/cloud.order.rule.InstanceCategories'
x-badges:
- color: green
label: Stable production 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(\"/cloud/order/rule/instanceCategory\")\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(\"/cloud/order/rule/instanceCategory\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: account:apiovh:cloud/order/rule/instanceCategory/get
required: true
tags:
- Cloud
/cloud/project:
get:
summary: OVH Cloud List available services
security:
- oAuth2AuthCode: []
parameters:
- in: query
name: iamTags
description: Filter resources on IAM tags
schema:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/iam.resource.TagFilter'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: string
x-badges:
- color: green
label: Stable production 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(\"/cloud/project\")\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(\"/cloud/project\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:get
required: true
x-expanded-response: CloudProjectWithIAM
tags:
- Cloud
/cloud/project/{serviceName}:
get:
summary: OVH Cloud Get this object properties
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/cloud.ProjectWithIAM'
x-badges:
- color: green
label: Stable production 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(\"/cloud/project/{serviceName}\")\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(\"/cloud/project/{serviceName}\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:get
required: true
tags:
- Cloud
put:
summary: OVH Cloud Alter this object properties
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloud.Project'
responses:
'200':
description: successful operation
x-badges:
- color: green
label: Stable production 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\n# Request body type: cloud.Project\nresult = client.put(\"/cloud/project/{serviceName}\",\n\tmanualQuota = None, # Manual quota prevent automatic quota upgrade (type: boolean)\n\tdescription = None, # Description of your project (type: string, nullable)\n)\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// Request body type: cloud.Project\n$result = $ovh->put(\"/cloud/project/{serviceName}\", array(\n\tdescription => null, // Description of your project (type: string, nullable)\n\tmanualQuota => null, // Manual quota prevent automatic quota upgrade (type: boolean)\n));\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:edit
required: true
tags:
- Cloud
/cloud/project/{serviceName}/activateMonthlyBilling:
post:
summary: OVH Cloud Activate monthly billing on multiple instances
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloud.ProjectActivateMonthlyBillingCreation'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/cloud.instance.InstanceDetail'
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\n# Request body type: cloud.ProjectActivateMonthlyBillingCreation\nresult = client.post(\"/cloud/project/{serviceName}/activateMonthlyBilling\",\n\tinstances = None, # Instance ids and regions (type: array)\n)\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// Request body type: cloud.ProjectActivateMonthlyBillingCreation\n$result = $ovh->post(\"/cloud/project/{serviceName}/activateMonthlyBilling\", array(\n\tinstances => null, // Instance ids and regions (type: array)\n));\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:activateMonthlyBilling
required: true
tags:
- Cloud
/cloud/project/{serviceName}/capabilities/containerRegistry:
get:
summary: OVH Cloud List container registry capabilities per region
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/cloud.containerRegistry.Capability'
x-badges:
- color: green
label: Stable production 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(\"/cloud/project/{serviceName}/capabilities/containerRegistry\")\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(\"/cloud/project/{serviceName}/capabilities/containerRegistry\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:capabilities/containerRegistry/get
required: true
tags:
- Cloud
/cloud/project/{serviceName}/capabilities/kube/admissionplugins:
get:
summary: OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled.
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/cloud.ProjectKubeCustomizationAPIServerAdmissionPluginsEnum'
x-badges:
- color: green
label: Stable production 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(\"/cloud/project/{serviceName}/capabilities/kube/admissionplugins\")\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(\"/cloud/project/{serviceName}/capabilities/kube/admissionplugins\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:capabilities/kube/admissionplugins/get
required: true
tags:
- Cloud
/cloud/project/{serviceName}/capabilities/kube/flavors:
get:
summary: OVH Cloud List Kubernetes available flavors for a region
security:
- oAuth2AuthCode: []
parameters:
- in: query
name: region
description: 'The region to list available flavors from. Example: GRA11.'
schema:
type: string
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/cloud.kube.Flavor'
x-badges:
- color: green
label: Stable production 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(\"/cloud/project/{serviceName}/capabilities/kube/flavors\")\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(\"/cloud/project/{serviceName}/capabilities/kube/flavors\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:capabilities/kube/flavors/get
required: true
tags:
- Cloud
/cloud/project/{serviceName}/capabilities/kube/log/kind:
get:
summary: OVH Cloud List available log kinds
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: string
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(\"/cloud/project/{serviceName}/capabilities/kube/log/kind\")\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(\"/cloud/project/{serviceName}/capabilities/kube/log/kind\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:capabilities/kube/log/kind/get
required: true
x-expanded-response: DbaasLogsLogKind
tags:
- Cloud
/cloud/project/{serviceName}/capabilities/kube/log/kind/{name}:
get:
summary: OVH Cloud Get a log kind
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: name
description: Name
required: true
schema:
type: string
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/dbaas.logs.LogKind'
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(\"/cloud/project/{serviceName}/capabilities/kube/log/kind/{name}\")\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(\"/cloud/project/{serviceName}/capabilities/kube/log/kind/{name}\");\n\nprint_r($result);\n?>"
x-iam-actions:
- name: publicCloudProject:apiovh:capabilities/kube/log/kind/get
required: true
x-response-identifier: name
tags:
- Cloud
/cloud/project/{serviceName}/capabilities/kube/regions:
get:
summary: OVH Cloud List Kubernetes regions where cluster creation is possible.
security:
- oAuth2AuthCode: []
parameters:
- in: path
name: serviceName
description: Service name
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: string
x-badges:
- color: green
label: Stable production 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/c
# --- truncated at 32 KB (6086 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ovh-cloud/refs/heads/main/openapi/ovh-cloud-cloud-api-openapi.yml