API Shell pour cPanel

Les API cPanel exposent toutes les fonctions du panneau (création de boîte email, gestion DNS, sauvegardes…) sous forme d'appels programmables. L'API Shell vous permet de les invoquer directement depuis le navigateur sans écrire la moindre ligne de code — pratique pour valider une signature avant de l'intégrer dans un script PHP, Node ou shell.

Accéder à l'interface

1. Connectez-vous à cPanel.
2. Section Avancé → cliquez sur API Shell.
3. L'interface affiche un sélecteur de module, un sélecteur de fonction, un éditeur JSON pour les paramètres et un bouton Exécuter.

Comprendre les deux API disponibles

Exécuter un appel UAPI

1. Choisissez UAPI dans le sélecteur d'API.
2. Sélectionnez le Module (ex. : Email).
3. Sélectionnez la Fonction (ex. : list_pops).
4. Renseignez les paramètres en JSON s'il y en a (ex. : {"domain": "exemple.com"}).
5. Cliquez sur Exécuter — la réponse JSON apparaît en bas dans une zone formatée.

Exemple : lister les comptes email

Module : Email
Fonction : list_pops
Paramètres : {}

Réponse attendue :
{
  "data": [
    { "email": "contact@exemple.com", "humandiskquota": "1024 MB" },
    { "email": "ventes@exemple.com",  "humandiskquota": "5120 MB" }
  ],
  "errors": null,
  "messages": null,
  "metadata": { ... },
  "status": 1
}

Exemple : créer un compte email

Module : Email
Fonction : add_pop
Paramètres :
{
  "email": "test",
  "password": "MotDePasseFort!2026",
  "quota": 1024,
  "domain": "exemple.com"
}

Lire la réponse

Bonnes pratiques

• Validez toujours en lecture seule (list_*, get_*) avant les actions d'écriture.
• Documentez chaque appel testé dans un fichier README de votre projet.
• Utilisez des comptes cPanel de test pour les fonctions destructives (delete_pop, kill_database…).
• Référez-vous à la documentation officielle UAPI pour la liste complète des modules et fonctions.

Dépannage

« Function not found »

Vérifiez l'orthographe exacte (sensible à la casse) et que vous êtes bien sur la bonne API (UAPI vs cPanel API 2).

« Access denied »

La fonction nécessite des privilèges absents de votre pack ou est restreinte par la politique de sécurité Cmediahost. Contactez le support.