Descripción general:
Esta herramienta te permite ejecutar funciones del API de cPanel de forma interactiva.
Advertencia:
Esta función trabaja con datos reales de tu servidor. Las llamadas al API pueden modificar o eliminar información, lo que podría ocasionar fallos graves en el servidor.
Antes de usar cualquier función dentro de la interfaz del API Shell, en un script o por otro medio, te recomendamos leer a detalle la documentación correspondiente.
Si deseas ver un ejemplo de los resultados que devuelve una función usando datos de prueba, consulta la sección de Ejemplo dentro de la documentación para desarrolladores.
Activar la interfaz de API Shell
Para poder usar esta herramienta, tu proveedor de hosting debe activarla. Pídeles que sigan estos pasos desde WHM:
-
Ir a WHM >> Configuración del servidor >> Configuración del sistema (Tweak Settings)
En la pestaña Sistema, activar la opción:
"cPanel & WHM API shell (para desarrolladores)". -
Otorgar el permiso del API Shell a los usuarios deseados desde:
WHM >> Paquetes >> Administrador de funciones (Feature Manager).
⚠️ Nota importante:
Debes usar una cuenta con privilegios de revendedor (reseller) para poder acceder a la interfaz del API Shell.
Cómo ejecutar una función del API
Para probar una función del API, sigue estos pasos:
-
Selecciona el API que deseas usar.
Solo están disponibles las versiones cPanel API 2 y UAPI en esta interfaz.
Para más información sobre las funciones, consulta las guías:
Guía de UAPI y Guía de cPanel API 2 -
Selecciona la función específica que quieres probar del menú.
-
Ingresa las llaves (keys) y valores (values) que deseas probar.
Si necesitas más campos, haz clic en "Agregar" (Add).
Opciones avanzadas: filtros, ordenamiento y paginación
-
Para filtrar, ordenar o paginar resultados, haz clic en "Mostrar opciones de ordenamiento/filtros/paginación".
-
Índice del primer resultado a mostrar:
Ingresa el número inicial desde donde quieres que empiecen los resultados (comienza desde 0). -
Número máximo de resultados:
Indica cuántos resultados deseas mostrar como máximo. -
Para aplicar filtros personalizados:
Haz clic en "Agregar" dentro de la sección de Filtros.
Ahí puedes definir el campo, la condición, y el valor del filtro.
Puedes añadir varios filtros repitiendo el proceso. -
Para ordenar los resultados:
Haz clic en "Agregar" en la sección de Ordenamiento.
Define el campo por el cual ordenar, la condición, y si deseas que el orden sea ascendente o descendente. -
Para limitar las columnas que se mostrarán:
Haz clic en "Agregar" en la sección de Columnas.
Ingresa el número de columna o nombre. Puedes añadir varias.
Resultados de la llamada al API
Los resultados aparecerán en la sección de respuesta del API. Puedes visualizarlos en tres formatos:
-
Vista de tabla (Table view)
-
Vista en árbol (Tree view)
-
Respuesta en crudo (Raw response)
Nota:
En la vista cruda (Raw), se muestra separada la respuesta del API y las cabeceras HTTP.
