Comment créer et gérer une application web en utilisant l'API publique OVHcloud

Base de connaissances

Comment créer et gérer une application web en utilisant l'API publique OVHcloud


Icons/System/eye-open Created with Sketch. 128 vues 05.09.2024 Web / Hébergement Web

Objectif

Ce guide vous explique comment utiliser l'API publique OVHcloud pour créer et gérer une application web sur votre hébergement. Vous apprendrez à effectuer des opérations clés telles que rattacher des domaines, gérer des bases de données ou encore la configuration de certificats SSL.

Prérequis

L'utilisation des APIs OVHcloud nécessite des connaissances avancées dans ce domaine. Si vous éprouvez des difficultés, contactez les partenaires OVHcloud.

En pratique

Récupération des informations de service

La première étape consiste à récupérer le serviceName, un identifiant unique pour votre service d'hébergement web. Vous en aurez besoin pour la plupart des appels API suivants.

Cette commande renvoie une liste de vos services d'hébergement web. Chaque entrée de la liste est un serviceName.

Exemple de réponse :

[
  "example.cluster01.hosting.ovh.net",
  "example2.cluster02.hosting.ovh.net"
]

Attacher un domaine

Attachez un domaine à votre service d'hébergement web.

ParamètreObligatoireDescription
serviceNameouiNom du service
bypassDNSConfigurationnonSi activé, la zone DNS ne sera pas mise à jour
cdnnonIndique si le domaine est lié au CDN de l'hébergement. Valeurs autorisées : active┃none
domainnonDomaine à lier
firewallnonIndique si le pare-feu est actif pour ce domaine. Valeurs autorisées : active┃none
ipLocationnonDéfinit la localisation IP associée au domaine. Valeurs autorisées : BE┃CA┃CZ┃DE┃ES┃FI┃FR┃IE┃IT┃LT┃NL┃PL┃PT┃UK
ownLognonDomaine pour séparer les logs
pathnonChemin où seront stockés les fichiers web
runtimeIdnonIdentifiant de configuration runtime utilisé sur ce domaine
sslnonOption pour activer le SSL pour le domaine

Exemple de réponse :

{
 "doneDate": "2024-08-22T08:13:50.740Z",
 "function": "abuse/close",
 "id": 0,
 "lastUpdate": "2024-08-22T08:13:50.740Z",
 "objectId": "string",
 "objectType": "Abuse",
 "startDate": "2024-08-22T08:13:50.740Z",
 "status": "cancelled"
}

Générer des certificats SSL

Configurez et gérez des certificats SSL pour sécuriser votre site web.

ParamètreObligatoireDescription
serviceNameouiNom du service
certificatenonCertificat SSL à installer
chainnonChaîne de certificats utilisée pour valider le certificat SSL
keynonClé privée associée au certificat SSL

Exemple de réponse :

{
 "isReportable": false,
 "provider": "COMODO",
 "regenerable": false,
 "status": "created",
 "taskId": 0,
 "type": "CUSTOM"
}

Gérer les bases de données

Les API Web Hosting d'OVHcloud vous permettent également de gérer vos bases de données.

Créer une base de données

ParamètreObligatoireDescription
serviceNameouiNom du service
capabilitieouiCapacités de la BDD. Valeurs : extraSqlPerso┃local┃privateDatabase┃sqlLocal┃sqlPerso┃sqlPro
userouiNom d'utilisateur de la BDD. Doit être en minuscule et commencer par votre identifiant d'hébergement web
passwordnonMot de passe de la BDD
quotanonEspace alloué. Valeurs : 25┃100┃200┃256┃400┃512┃800┃1024
typeouiType de la BDD. Valeurs : mariadb┃mysql┃postgresql┃redis
versionnonVersion de la BDD

Exemple de réponse :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Lister les bases de données existantes

Listez toutes les bases de données associées à votre service d'hébergement web.

ParamètreObligatoireDescription
serviceNameouiNom du service
modeouiValeurs autorisées : besteffort ┃ classic ┃ module

Exemple de réponse :

[
 "example.mysql.db",
 "example2.mysql.db"
]

Gérer les modules

Récupérer une liste de modules

Obtenez une liste de modules disponibles que vous pouvez installer sur votre hébergement web.

ParamètreObligatoireDescription
activenonFiltre les modules activés ou désactivés
branchnonFiltre les modules en fonction de leur version. Valeurs autorisées : old ┃ stable ┃ testing
latestnonFiltre permettant d'afficher les modules correspondant à la version la plus récente

Exemple de réponse :

[
 195,
 184,
 38,
 176
]

Récupérer les informations d'un module

Obtenez les détails d'un module spécifique installé sur votre hébergement web.

ParamètreObligatoireDescription
idouiIdentifiant du module

Exemple de réponse :

{
 "keywords": [
   "gallery"
 ],
 "adminNameType": "string",
 "author": "OVH",
 "branch": "old",
 "id": 195,
 "size": {
   "value": 0,
   "unit": "B"
 },
 "name": "myname",
 "upgradeFrom": [],
 "language": [
   "en",
   "fr",
   "de",
   "es",
   "pl"
 ],
 "version": "1.4.2.2",
 "active": false,
 "languageRequirement": {
   "value": "php",
   "unit": "supported versions: ''\nnon supported versions: '8+'"
 },
 "latest": true
}

Installer un nouveau module

Installez un nouveau module sur votre service d'hébergement web.

ParamètreObligatoireDescription
serviceNameouiNom du service
moduleIdouiIdentifiant du module à installer
adminNamenonNom de l'administrateur
adminPasswordnonMot de passe du compte administrateur
domainnonNom de domaine où le module sera déployé
languagenonLangue de l'installation du module
pathnonChemin sur le serveur où le module sera installé
dependencies -> namenonNom du service dépendant
dependencies -> passwordnonMot de passe pour le service dépendant
dependencies -> portnonPort de connexion du service
dependencies -> prefixnonPréfixe utilisé dans la configuration du service
dependencies -> servernonAdresse du serveur du service dépendant
dependencies -> typenonType de service (ex. : MySQL)
dependencies -> usernonNom d'utilisateur pour le service dépendant

Exemple de réponse :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Gérer les utilisateurs FTP

Gérez les utilisateurs FTP/SSH de votre hébergement web pour faciliter les accès et les configurations.

Créer un nouvel utilisateur FTP/SSH

Créez un nouvel utilisateur FTP ou SSH pour accéder à votre hébergement web.

ParamètreObligatoireDescription
serviceNameouiNom du service
homeouiRépertoire d'accueil
loginouiNom d'utilisateur
passwordouiMot de passe
sshStatenonDétermine l'état d'accès SSH pour l'utilisateur. Valeurs autorisées : active ┃none ┃sftponly

Exemple de réponse :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Lister les utilisateurs FTP/SSH

Listez tous les utilisateurs FTP/SSH existants sur votre service d'hébergement.

ParamètreObligatoireDescription
serviceNameouiNom du service
homenonFiltre les utilisateurs en fonction de leur répertoire principal
loginnonFiltre les utilisateurs en fonction de leur nom d'utilisateur

Exemple de réponse :

[
 "user1",
 "user2",
 "user3",
 "user4"
]

Restaurer une base de données

Créez, listez et restaurez des sauvegardes de bases de données pour votre site web.

Créer une sauvegarde d'une base de données

Créez une sauvegarde de votre base de données pour la restaurer en cas de besoin.

ParamètreObligatoireDescription
serviceNameouiNom du service
nameouiNom de la base de données
dateouiType de sauvegarde. Valeurs autorisées : daily.1┃now┃weekly.1
sendEmailnonSi ce paramètre est activé, un e-mail est envoyé lorsque la sauvegarde est disponible

Exemple de réponse :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Lister les sauvegardes de bases de données disponibles

Listez toutes les sauvegardes disponibles pour vos bases de données.

ParamètreObligatoireDescription
serviceNameouiNom du service
nameouiNom de la base de données
creationDate.fromnonFiltre les sauvegardes créées à partir de cette date
creationDate.tononFiltre les sauvegardes créées jusqu'à cette date
deletionDate.fromnonFiltre les sauvegardes supprimées à partir de cette date
deletionDate.tononFiltre les sauvegardes supprimées jusqu'à cette date
typenonFiltre les sauvegardes selon leur type. Valeurs autorisées : daily.1┃now┃weekly.1

Exemple de réponse :

[
 1,
 12
]

Restaurer une sauvegarde spécifique d'une base de données

Restaurez une sauvegarde spécifique de votre base de données en cas de problème.

ParamètreObligatoireDescription
serviceNameouiNom du service
nameouiNom de la base de données
idouiIdentifiant de la sauvegarde

Exemple de réponse :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Conclusion

Ce guide vous a présenté les principales requêtes API pour gérer votre hébergement web OVHcloud, comme l'attachement de domaines, la gestion des certificats SSL et des bases de données.

Il existe cependant de nombreux autres appels API disponibles, que vous pouvez explorer en fonction de vos besoins spécifiques. Pour plus d'options et de fonctionnalités, vous pouvez consulter la section « /hosting/web » de l'API OVHcloud.

Aller plus loin

Commander un nom de domaine via API

Échangez avec notre communauté d'utilisateurs.

Articles associés