Connexion à l'API OVH

Objectif

L'API OVH permet de réaliser certaines actions parfois non disponibles dans l'espace client OVH.

Elle permet également d'automatiser certaines actions.

Ce guide montre plusieurs exemples.

Connexion à L'API

Rendez-vous sur l'API ovh.com : http://api.ovh.com

Cliquez sur "Explore the OVH API".

Une fois sur l'interface, cliquez sur le lien login.

Entrez votre nic-handle et votre mot de passe. Les logins sont les mêmes que pour l'espace client OVH.

Utilisation de l'API

Rendez vous dans la partie dedicatedCloud.

Cliquez sur la partie /dedicatedCloud/ Vous trouverez différents appels possibles (GET, PUT, POST, DELETE).

GET

L'appel GET permet de sortir des informations sur votre infrastructure, cela n'effectura aucune modification.

Exemple : cliquez sur la partie /dedicatedCloud/{serviceName} et renseignez votre Private Cloud dans le champ. Après avoir cliqué sur "Execute", le résultat sera similaire à :

PUT

L'appel PUT, permet de modifier un existant.

Exemple : Après avoir récupéré les informations sur mon datacentre avec l'appel suivant : /dedicatedCloud/{serviceName}/datacenter/{datacenterId}

Je modifie la description avec l'appel PUT : /dedicatedCloud/{serviceName}/datacenter/{datacenterId}

Et voici les informations mise à jour :

POST

L'appel POST, permet de créer une nouvelle entrée.

Exemple : Je souhaite autoriser une IP pouvant se connecter au client vSphere avec l'appel suivant : /dedicatedCloud/{serviceName}/allowedNetwork

L'IP est ajouté est vérifiable avec l'appel suivant : /dedicatedCloud/{serviceName}/allowedNetwork/{networkAccessId} (le networkAccessId est visible dans l'appel précedent).

DELETE

L'appel DELETE permet de supprimer une entrée.

Exemple : Je souhaite supprimer un datacentre virtuel, ce dernier étant vide, l'appel suivant permet de le supprimer : /dedicatedCloud/{serviceName}/datacenter/{datacenterId}

Utilisation annexe

L'API OVH peut être utilisé en complément du SDK vSphere afin d'automatiser toute votre infrastructure.

Aller plus loin

Échangez avec notre communauté d'utilisateurs.