Vue d'ensemble
Cette interface vous permet d'exécuter les fonctions API de cPanel de manière interactive.
Important :
Cette interface est uniquement disponible pour les comptes revendeurs.
Seules les fonctions API 2 et UAPI de cPanel sont disponibles dans l'interface API Shell.
Avertissement :
Cette fonction utilise des données en direct de votre serveur. Les appels de fonction API peuvent modifier ou supprimer des données sur votre serveur, ce qui peut provoquer une panne de votre serveur.
Lisez attentivement la documentation d'une fonction avant de l'utiliser dans l'interface API Shell.
Pour voir un exemple de sortie de la fonction, lisez la section Response samples (Exemples de réponses) de la fonction dans notre documentation pour les développeurs de cPanel.
Activer l'interface API Shell
Pour utiliser cette fonction, votre hébergeur doit l'activer pour vous. Demandez-lui d'effectuer les étapes suivantes dans WHM :
Sélectionnez On pour le paramètre cPanel & WHM API shell (for developers) dans l'onglet System de l'interface Tweak Settings de WHM (WHM >> Home >> Server Configuration >> Tweak Settings).
Accordez la fonction API Shell à la liste des fonctions de votre compte dans l'interface Feature Manager de WHM (WHM >> Accueil >> Packages >> Feature Manager).
Appeler une fonction API
Pour appeler une fonction API, procédez comme suit :
Sélectionnez l'option UAPI (API 3) ou API 2 dans la section Version API de cPanel.
Sélectionnez la fonction API dans le menu de la version API sélectionnée.
Dans la section Variables, entrez les clés et les valeurs de la fonction API dans les zones de texte. Si la fonction API a des paires de clés et de valeurs requises, vous devez les saisir.
Pour ajouter une nouvelle entrée de variable, cliquez sur Ajouter.
Pour supprimer une entrée de variable, cliquez sur l'icône X.
Pour filtrer, trier ou paginer les résultats, cliquez sur Afficher les options de tri/filtrage/pagination :
Pour sélectionner le premier enregistrement à afficher parmi les résultats, saisissez un nombre dans la zone de texte Index des premiers résultats à afficher, basé sur zéro ou utilisez le menu pour sélectionner un nombre.
Une valeur de 0 affiche des résultats illimités.
Pour limiter le nombre de résultats à afficher, entrez un nombre dans la zone de texte Nombre maximal de résultats à afficher ou utilisez le menu pour sélectionner un nombre.
Une valeur de 0 affiche un nombre illimité de résultats.
Pour filtrer les résultats, cliquez sur Ajouter dans la section Filtres de l'interface. Vous pouvez spécifier le champ à utiliser pour filtrer les résultats, les conditions (Contient, Commence par, Egal, Supérieur à (numérique) ou Inférieur à (numérique)) et le terme à appliquer aux conditions.
Pour ajouter un nouveau filtre, cliquez sur Ajouter.
Pour supprimer un filtre, cliquez sur l'icône X.
Pour trier les résultats, cliquez sur Ajouter dans la section Tri de l'interface. Vous pouvez spécifier un champ par lequel vous souhaitez trier les résultats, les conditions (lexicographique, numérique, numérique_zéro_comme_max, ou ipv4), et si vous souhaitez inverser l'ordre de tri.
Pour ajouter une nouvelle méthode de tri, cliquez sur Ajouter.
Pour supprimer un ordre de tri, cliquez sur l'icône X.
Pour limiter les colonnes à afficher, cliquez sur Ajouter dans la section Colonnes de l'interface. Ensuite, saisissez le numéro de la colonne dans la zone de texte Colonne.
Pour ajouter d'autres colonnes à afficher, cliquez sur Ajouter.
Pour supprimer une colonne, cliquez sur l'icône X.
Cliquez sur Soumettre.
Lorsque vous modifiez les valeurs de la fonction API, l'interface met à jour les entrées des sections URL et structure de données d'appel API.
Réponse à l'appel API
Après avoir cliqué sur Soumettre, les résultats de la fonction API apparaissent dans la section Réponse à l'appel API de l'interface. Vous pouvez afficher les résultats dans les onglets Arborescence, Tableau et Vue brute.
Remarque :
L'onglet Vue brute sépare la réponse de l'appel API des en-têtes HTTP.
L'affichage sous forme de tableau peut être indisponible pour certaines données de fonction.
