You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
excerpt: 'Discover how to explore the OVHcloud APIs'
5
-
section: 'First steps'
5
+
section: 'Getting started'
6
+
order: 02
6
7
updated: 2023-03-27
7
8
---
8
9
9
10
**Last updated March 27th 2023**
10
11
11
12
## Objective
12
13
13
-
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 Control Panel.
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.
14
15
15
16
**Discover how to explore the OVHcloud APIs on our brand new console**
16
17
@@ -27,39 +28,38 @@ The APIs available on [https://eu.api.ovh.com/](https://eu.api.ovh.com/){.extern
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.
28
29
>
29
30
30
-
### Simple Use
31
-
32
-
#### Sign in to OVHcloud APIs
31
+
### Signing in to OVHcloud APIs
33
32
34
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.
35
34
36
35
To use the APIs on your products, you must sign in to this site using your OVHcloud credentials.
37
36
38
37
- Click `Authentication`{.action} in the upper left.
39
-
- 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`.
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}.
40
39
- You will be redirected to the OVHcloud authentication page on which you need to enter your OVHcloud credentials.
41
-
- Once your credentials validated, you will be redirected on the API console and will be able to try calls.
40
+
- Once your credentials are validated, you will be redirected on the API console and will be able to try calls.
42
41
43
42
{.thumbnail}
44
43
45
44
> [!primary]
46
45
>
47
-
> If your OVHcloud account is protected by [two-factor authentication](https://docs.ovh.com/us/en/customer/secure-account-with-2FA/), you will also need to enter the code generated by SMS or OTP mobile application or U2F key.
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.
48
47
>
49
48
50
-
#### Explore the available products on OVHcloud APIs
49
+
###Exploring the available products on OVHcloud APIs
51
50
52
-
##### API branch selection
51
+
####Selecting the API branch
53
52
54
53
Several branches of OVHcloud APIs are available:
54
+
55
55
-**V1**: the API available at [https://eu.api.ovh.com/v1](https://eu.api.ovh.com/v1)
56
56
-**V2**: the new OVHcloud API, available at [https://eu.api.ovh.com/v2](https://eu.api.ovh.com/v2)
57
57
58
58
The API branch can be selected using the drop-down menu in the upper left.
59
59
60
60
{.thumbnail}
61
61
62
-
##### API section selection
62
+
####Selecting the API section
63
63
64
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
65
@@ -69,82 +69,85 @@ You can choose a section in the drop-down menu just next to the branch-selection
69
69
70
70
Once you have selected an API section, the operations it contains are displayed in the left menu.
71
71
72
-
#####Exploring the operations
72
+
#### Exploring the operations
73
73
74
74
The list of operations of the selected API section is displayed in the lower part of the left menu.
75
75
76
76
{.thumbnail}
77
77
78
78
Each line contains the following pieces of information:
79
+
79
80
- HTTP verb of the operation (GET, PUT, POST, PATCH, DELETE)
80
81
- Path of the operation
81
-
- Operation's state: if the operation is in state *alpha* or *beta*, you will see a badge on the right of the operation's path.
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.
82
83
83
84
{.thumbnail}
84
85
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.
0 commit comments