1. Articles
  2. Server Administration
  3. Start Here

Articles in this section

Overview of the New OVHcloud API Console

Avatar
Stephanie Richards
  • Updated
Follow

The APIs available on https://api.us.ovhcloud.com/ 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 our brand new console

Requirements

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

Instructions

NOTE: 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.

Signing in to OVHcloud APIs

On the OVHcloud API page, click Try the new OVHcloud API console to view the list of APIs.

To use the APIs on your products, you must sign in to this site using your OVHcloud credentials.

  • Click Authentication in the upper left.
  • The authentication process uses OAuth2 protocol with scopes. To authenticate yourself, you have to choose at least one scope from the list. A scope will limit the access of the generated token to a subset of the API operations. For this tutorial, simply select the scope all that allows all API operations, then click on GET TOKEN.
  • You will be redirected to the OVHcloud authentication page on which you need to enter your OVHcloud credentials.
  • Once your credentials are validated, you will be redirected to the API console and will be able to try calls.

newAPIconsole01.png

If your OVHcloud account is protected by two-factor authentication, you will also need to enter the code generated by SMS or OTP mobile application or U2F key.

 

Exploring the available products on OVHcloud APIs

Selecting the API branch

Several branches of OVHcloud APIs are available:

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

newAPIconsole02.png

 

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.

newAPIconsole03.png

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.

newAPIconsole04*.png

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.

newAPIconsole05.png

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.

newAPIconsole06.png

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

This view is divided into 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

newAPIconsole07*.png

 

Request

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

  • Path parameters

newAPIconsole08*.png

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

newAPIconsole09.png

  • Query parameters

newAPIconsole10.png

  • 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.

newAPIconsole11.png

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

newAPIconsole12.png

 

Response

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

newAPIconsole13*.png

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

newAPIconsole14*.png

 

Code samples

This section provides template examples to be used, whether you use Python or PHP language for development.

newAPIconsole15*.png

newAPIconsole16*.png

 

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

newAPIconsole15*.png

When clicking this button, a popup window is opened allowing you to search through operations 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

newAPIconsole16*.png

 

Executing requests

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

newAPIconsole17*.png

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: shows the equivalent of the request using the tool curl

 

Go further

For more information and tutorials, please see our guides for other OVHcloud products and services.

Related articles