|
| 1 | +--- |
| 2 | +title: 'Exploring the OVHcloud APIs' |
| 3 | +slug: api-console-exploration |
| 4 | +excerpt: 'Discover how to explore the OVHcloud APIs' |
| 5 | +section: 'Getting started' |
| 6 | +order: 02 |
| 7 | +updated: 2023-03-27 |
| 8 | +--- |
| 9 | + |
| 10 | +**Last updated March 27th 2023** |
| 11 | + |
| 12 | +## Objective |
| 13 | + |
| 14 | +The APIs available on [https://eu.api.ovh.com/](https://eu.api.ovh.com/){.external} allow you to purchase, manage, update and configure OVHcloud products without using a graphical interface such as the OVHcloud Control Panel. |
| 15 | + |
| 16 | +**Discover how to explore the OVHcloud APIs on our brand new console** |
| 17 | + |
| 18 | +## Requirements |
| 19 | + |
| 20 | +- You have an active OVHcloud account and know its credentials. |
| 21 | +- You are on the [OVHcloud API](https://eu.api.ovh.com/){.external} web page. |
| 22 | + |
| 23 | +## Instructions |
| 24 | + |
| 25 | +> [!warning] |
| 26 | +> 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. |
| 27 | +> |
| 28 | +> 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”](#gofurther) section of this guide. |
| 29 | +> |
| 30 | +
|
| 31 | +### Signing in to OVHcloud APIs |
| 32 | + |
| 33 | +On the [OVHcloud API](https://eu.api.ovh.com/) page, click `Try the new OVHcloud API console`{.action} to view the list of APIs. |
| 34 | + |
| 35 | +To use the APIs on your products, you must sign in to this site using your OVHcloud credentials. |
| 36 | + |
| 37 | +- Click `Authentication`{.action} in the upper left. |
| 38 | +- 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`{.action}. |
| 39 | +- You will be redirected to the OVHcloud authentication page on which you need to enter your OVHcloud credentials. |
| 40 | +- Once your credentials are validated, you will be redirected on the API console and will be able to try calls. |
| 41 | + |
| 42 | +{.thumbnail} |
| 43 | + |
| 44 | +> [!primary] |
| 45 | +> |
| 46 | +> If your OVHcloud account is protected by [two-factor authentication](https://docs.ovh.com/gb/en/customer/secure-account-with-2FA/), you will also need to enter the code generated by SMS or OTP mobile application or U2F key. |
| 47 | +> |
| 48 | +
|
| 49 | +### Exploring the available products on OVHcloud APIs |
| 50 | + |
| 51 | +#### Selecting the API branch |
| 52 | + |
| 53 | +Several branches of OVHcloud APIs are available: |
| 54 | + |
| 55 | +- **V1**: the API available at [https://eu.api.ovh.com/v1](https://eu.api.ovh.com/v1) |
| 56 | +- **V2**: the new OVHcloud API, available at [https://eu.api.ovh.com/v2](https://eu.api.ovh.com/v2) |
| 57 | + |
| 58 | +The API branch can be selected using the drop-down menu in the upper left. |
| 59 | + |
| 60 | +{.thumbnail} |
| 61 | + |
| 62 | +#### Selecting the API section |
| 63 | + |
| 64 | +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. |
| 65 | + |
| 66 | +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. |
| 67 | + |
| 68 | +{.thumbnail} |
| 69 | + |
| 70 | +Once you have selected an API section, the operations it contains are displayed in the left menu. |
| 71 | + |
| 72 | +#### Exploring the operations |
| 73 | + |
| 74 | +The list of operations of the selected API section is displayed in the lower part of the left menu. |
| 75 | + |
| 76 | +{.thumbnail} |
| 77 | + |
| 78 | +Each line contains the following pieces of information: |
| 79 | + |
| 80 | +- HTTP verb of the operation (GET, PUT, POST, PATCH, DELETE) |
| 81 | +- Path of the operation |
| 82 | +- 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. |
| 83 | + |
| 84 | +{.thumbnail} |
| 85 | + |
| 86 | +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. |
| 87 | + |
| 88 | +{.thumbnail} |
| 89 | + |
| 90 | +Once you select an operation, its detailed information will be displayed on the right side of the page. |
| 91 | + |
| 92 | +This view is divided in four subsections described below. |
| 93 | + |
| 94 | +##### **General information** |
| 95 | + |
| 96 | +This subsection contains basic information about the operation: |
| 97 | + |
| 98 | +- State of the operation (e.g. *Beta version*) |
| 99 | +- Description of the operation |
| 100 | +- Path of the operation and HTTP verb |
| 101 | + |
| 102 | +{.thumbnail} |
| 103 | + |
| 104 | +##### **Request** |
| 105 | + |
| 106 | +This subsection describes the input parameters of the operation. Depending on the operation's parameters, the following information will be displayed: |
| 107 | + |
| 108 | +- **Path parameters** |
| 109 | + |
| 110 | +{.thumbnail} |
| 111 | + |
| 112 | +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. |
| 113 | + |
| 114 | +- **Header parameters** |
| 115 | + |
| 116 | +{.thumbnail} |
| 117 | + |
| 118 | +- **Query parameters** |
| 119 | + |
| 120 | +{.thumbnail} |
| 121 | + |
| 122 | +- **Request body** |
| 123 | + |
| 124 | +This subsection describes the request body. The default view shows an example body that can be used in a request. |
| 125 | +These values can be modified directly in place to try the call with values corresponding to your services. |
| 126 | + |
| 127 | +{.thumbnail} |
| 128 | + |
| 129 | +There is also a tab *SCHEMA* that exposes the details of type, description, and allowed values for each parameter. |
| 130 | + |
| 131 | +{.thumbnail} |
| 132 | + |
| 133 | +##### **Response** |
| 134 | + |
| 135 | +This section is similar to the previous one and describes the operation's response. |
| 136 | + |
| 137 | +{.thumbnail} |
| 138 | + |
| 139 | +The *SCHEMA* tab is also available to get the details of the returned fields alongside with their description. |
| 140 | + |
| 141 | +{.thumbnail} |
| 142 | + |
| 143 | +#### Advanced search |
| 144 | + |
| 145 | +An advanced search is available by clicking on the `Search`{.action} button in the upper left. |
| 146 | + |
| 147 | +{.thumbnail} |
| 148 | + |
| 149 | +When clicking this button, a popup windows is opened allowing to search through operation with the following criteria: |
| 150 | + |
| 151 | +- Path of the operation |
| 152 | +- Description of the API route |
| 153 | +- Parameters of the operation |
| 154 | +- Fields of the operations's request body |
| 155 | +- Description of the operation's response |
| 156 | +- State of the operation |
| 157 | + |
| 158 | +{.thumbnail} |
| 159 | + |
| 160 | +### Executing requests |
| 161 | + |
| 162 | +From the console, it is possible to interact directly with the API using the `TRY`{.action} button. |
| 163 | + |
| 164 | +{.thumbnail} |
| 165 | + |
| 166 | +After having set all the required parameters (when necessary), this button allows you to make a real call to the OVHcloud API. |
| 167 | +When executing the request, the API response is displayed below the operation parameters. |
| 168 | + |
| 169 | +Three tabs are then available: |
| 170 | + |
| 171 | +- **RESPONSE**: response body of the API |
| 172 | +- **RESPONSE HEADERS**: headers returned by the API |
| 173 | +- **CURL**: show the equivalent of the request using the tool `curl` |
| 174 | + |
| 175 | +## Go further <a name="gofurther"></a> |
| 176 | + |
| 177 | +[Managing a Domain Name with the OVHcloud API](https://docs.ovh.com/gb/en/domains/api/) |
| 178 | + |
| 179 | +[How to manage a customer’s account via OVHcloud API](https://docs.ovh.com/gb/en/api/api-rights-delegation/) |
| 180 | + |
| 181 | +Join our community of users on <https://community.ovh.com/en/>. |
0 commit comments