Exploring the OVHcloud APIs

View as Markdown

Discover how to explore the OVHcloud APIs

Objective

The APIs available on allow you to purchase, manage, update and configure OVHcloud products without using a graphical interface such as the OVHcloud Control Panel.

Discover how to explore the OVHcloud APIs on the API console

Requirements

  • You have an active OVHcloud account and know its credentials.
  • You are on the web page.

Instructions

Warning

OVHcloud is providing you with services for which you are responsible, with regard to their configuration and management. You are therefore responsible for ensuring they function correctly.

This guide is designed to assist you in common tasks as much as possible. Nevertheless, we recommend contacting a specialised provider and/or the software publisher for the service if you encounter any difficulties. We will not be able to assist you ourselves. You can find more information in the “Go further” section of this guide.

Signing in to OVHcloud APIs

You can browse the API console without an account. To execute calls on your own products, sign in with your OVHcloud credentials via the Authentication entry in the upper left — the sign-in steps are covered in First steps with the OVHcloud APIs.

Exploring the available products on OVHcloud APIs

Selecting the API branch

Several branches of OVHcloud APIs are available:

  • V1: the API available at https://api.eu.ovhcloud.com/v1
  • V2: the new OVHcloud API, available at https://api.eu.ovhcloud.com/v2

The API branch can be selected using the drop-down menu in the upper left.

API

Selecting the API section

Once you have chosen an API branch, you can browse the different sections of the selected branch. The sections are sorted in alphabetical order and by default the first section is displayed.

You can choose a section in the drop-down menu just next to the branch-selection one. It is possible to filter out the list of sections by typing the name of the desired section.

API

Once you have selected an API section, the operations it contains are displayed in the left menu.

Exploring the operations

The list of operations of the selected API section is displayed in the lower part of the left menu.

API

Each line contains the following pieces of information:

  • HTTP verb of the operation (GET, PUT, POST, PATCH, DELETE)
  • Path of the operation
  • Operation's state: if the operation is in state alpha or beta, you will see a badge to the right of the operation's path.
API

If the operation is deprecated, the path will be greyed out in the list of operations. In the following example, the second operation is deprecated.

API

Once you select an operation, its detailed information will be displayed on the right side of the page.

This view is divided in four subsections described below.

General information

This subsection contains basic information about the operation:

  • State of the operation (e.g. Beta version)
  • Description of the operation
  • Path of the operation and HTTP verb
API
Request

This subsection describes the input parameters of the operation. Depending on the operation's parameters, the following information will be displayed:

  • Path parameters
API

The red star located on the left of the parameter's name indicates that this parameter is mandatory to be able to execute the request.

  • Header parameters
API
  • Query parameters
API
  • Request body

This subsection describes the request body. The default view shows an example body that can be used in a request. These values can be modified directly in place to try the call with values corresponding to your services.

API

There is also a tab SCHEMA that exposes the details of type, description, and allowed values for each parameter.

API
Response

This section is similar to the previous one and describes the operation's response.

API

The SCHEMA tab is also available to get the details of the returned fields alongside with their description.

API

An advanced search is available by clicking on the Search button in the upper left.

API

When clicking this button, a popup windows is opened allowing to search through operation with the following criteria:

  • Path of the operation
  • Description of the API route
  • Parameters of the operation
  • Fields of the operations's request body
  • Description of the operation's response
  • State of the operation
API

Executing requests

From the console, it is possible to interact directly with the API using the EXECUTE button.

API

After having set all the required parameters (when necessary), this button allows you to make a real call to the OVHcloud API. When executing the request, the API response is displayed below the operation parameters.

Three tabs are then available:

  • RESPONSE: response body of the API
  • RESPONSE HEADERS: headers returned by the API
  • CURL: show the equivalent of the request using the tool curl

Go further

Managing a Domain Name with the OVHcloud API

How to manage a customer’s account via OVHcloud API

Join our community of users.

Was this page helpful?