Utiliser l'API DirectAdmin : gérer votre forfait à l'aide de scripts

DirectAdmin dispose d'une API : une manière de gérer votre offre avec un script ou un programme plutôt qu'avec la souris. Presque tout ce que vous faites dans le panneau est aussi possible via l'API. Pensez à mettre à jour un enregistrement DNS lorsque votre adresse IP change à domicile, à créer des boîtes mail depuis votre propre logiciel ou à récupérer chaque nuit la liste de vos bases de données.

Puis-je utiliser l'API avec mon offre ?

Oui. L'API fonctionne avec toutes les offres incluant DirectAdmin : toutes les offres d'hébergement web ainsi que les offres e-mail. Les revendeurs peuvent en outre l'utiliser pour gérer les comptes de leurs propres clients. Vous n'avez rien à demander et cela n'entraîne aucun coût supplémentaire.

Un script dispose exactement des mêmes droits que vous dans DirectAdmin. Il ne peut donc agir que sur votre propre offre, et uniquement sur ce que votre offre autorise.

Comment cela fonctionne

• Adresse : vous communiquez avec l'API au même endroit que celui où vous vous connectez : https://nomdeserveur:2222. Vous trouvez le nom de votre serveur dans Mon WebOké, au niveau de l'offre, sous Gérer.
• Deux types de commandes : la nouvelle API, avec des adresses commençant par /api/ et des réponses en JSON, et l'ancienne API avec des commandes telles que /CMD_API_.... Commencez par la nouvelle API. Ce qui n'y figure pas encore se trouve dans l'ancienne API. Ajoutez-y ?json=yes pour obtenir une réponse en JSON.
• Connexion : chaque commande transmet votre nom d'utilisateur DA et un mot de passe (authentification HTTP Basic). Utilisez de préférence pour cela une clé de connexion (login key) et non votre véritable mot de passe DA, voir ci-dessous.
• Documentation dans votre propre panneau : dans DirectAdmin, vous trouvez sous Support & Help la rubrique API Documentation. Vous y voyez toutes les commandes de la nouvelle API et pouvez les tester immédiatement avec votre propre compte.

Un exemple

Avec cette commande, vous récupérez les bases de données de votre offre. Remplacez utilisateur, clé et nom de serveur par vos propres informations :

curl -u 'utilisateur:cle' https://nomdeserveur:2222/api/db-show/databases

Vous recevez une liste en JSON. Cela fonctionne de la même manière depuis PHP, Python ou tout autre langage capable d'interroger une adresse web.

Travailler en sécurité avec une clé de connexion

Ne communiquez jamais votre mot de passe DA habituel à un script. Créez dans DirectAdmin, sous Clés de connexion, une clé distincte. Vous pouvez limiter une telle clé :

• aux seules commandes dont le script a réellement besoin ;
• à la seule adresse IP de l'ordinateur ou du serveur sur lequel le script s'exécute ;
• avec une date d'expiration, si vous n'avez besoin de l'accès que temporairement.

Excluez en tout cas les commandes CMD_LOGIN_KEYS et CMD_PASSWD, afin que la clé ne puisse ni créer de nouvelles clés ni modifier votre mot de passe. Si la clé venait tout de même à fuiter, supprimez-la et créez-en une nouvelle, sans devoir changer votre mot de passe.

La manière de créer une clé est expliquée étape par étape dans le guide DirectAdmin : Clés de connexion : se connecter pour des scripts et des programmes.

Bon à savoir

• Si un script tente souvent de se connecter avec un mot de passe ou une clé incorrects, notre pare-feu bloque cette adresse IP. Consultez Suis-je bloqué ? si votre script n'arrive soudainement plus à se connecter.
• Nous vous aidons volontiers si l'API elle-même ne fonctionne pas, mais nous n'écrivons ni ne contrôlons de scripts personnels. Utilisez pour cela la documentation de DirectAdmin ci-dessous.
• Préférez-vous gérer votre hébergement avec Claude, ChatGPT ou Mistral, sans programmer vous-même ? Découvrez alors notre serveur MCP pour l'IA.

Documentation de DirectAdmin

La documentation de DirectAdmin est en anglais :

• API Access : fonctionnement de l'API, connexion et les différents types d'API.
• Examples : exemples avec curl, Bash, PHP et Python.
• Legacy API : les anciennes commandes CMD_API et leurs réponses.
• Aperçu des commandes CMD_API : recherche parmi toutes les anciennes commandes.
• Creating a login key : les clés de connexion selon DirectAdmin.

Voir aussi dans le guide DirectAdmin : Trouver le nom de votre serveur et votre nom d'utilisateur DA.