Shell de API para cPanel | Documentación de cPanel y WHM

API Shell para cPanel

Válido para las versiones 82 hasta la última versión


Última modificación: 28 de abril de 2021

Visión general

Esta interfaz le permite ejecutar funciones API de cPanel de forma interactiva.

Importante:

  • Esta interfaz es solamente disponible para cuentas de revendedor.
  • Solamente cPanel API 2 y UAPI las funciones están disponibles en el Shell de API interfaz.

Advertencia:

Esta característica utiliza En Vivo datos de su servidor. Las llamadas a la función API pueden cambiar o eliminar datos en su servidor, lo que puede hacer que su servidor falle.

  • Leer la documentación de una función minuciosamente antes de usarlo en el Shell de API interfaz.
  • Para ver un ejemplo de la salida de la función, lea la función Muestras de respuesta sección en nuestra Documentación para desarrolladores de cPanel.

Habilite la interfaz API Shell

Para utilizar esta función, su proveedor de alojamiento debe habilitarla. Pídales que realicen los siguientes pasos en WHM:

  1. Seleccione Sobre Para el Shell de API de cPanel y WHM (para desarrolladores) entorno en el Sistema pestaña de WHM Ajustar la configuración interfaz (WHM >> Inicio >> Configuración del servidor >> Ajustar la configuración).
  2. Otorga el Shell de API función a la lista de funciones de su cuenta en WHM Administrador de funciones interfaz (WHM >> Inicio >> Paquetes >> Administrador de funciones).

Llamar a una función de API

Para llamar a una función de API, realice los siguientes pasos:

  1. Seleccione el UAPI (API 3) o API 2 opción en el Versión de la API de cPanel sección.
  2. Seleccione la función de API en el menú de la versión de API seleccionada.
  3. En el Variables sección, ingrese las claves y los valores de la función API en los cuadros de texto. Si la función API tiene algún par de clave y valor requerido, debe entrar en ellos.
    • Para agregar una nueva entrada de variable, haga clic en Agregar.
    • Para eliminar una entrada de variable, haga clic en el X icono.
  4. Para filtrar, ordenar o paginar los resultados, haga clic en Mostrar opciones de ordenar / filtrar / paginar:
    • Para seleccionar el primer registro a mostrar de los resultados, ingrese un número en el Índice de primeros resultados para mostrar, basado en cero cuadro de texto o use el menú para seleccionar un número.
      • A 0 valor muestra resultados ilimitados.
    • Para limitar el número de resultados a mostrar, ingrese un número en el Cantidad máxima de resultados para mostrar cuadro de texto o use el menú para seleccionar un número.
      • A 0 valor muestra resultados ilimitados.
    • Para filtrar los resultados, haga clic en Agregar en el Filtros sección de la interfaz. Puede especificar el campo que se utilizará para filtrar los resultados, las condiciones (Contiene, Empieza con, Igual, Mayor que (numérico), o Menor que (numérico)), y el plazo a aplicar a las condiciones.
      • Para agregar un nuevo filtro, haga clic en Agregar.
      • Para eliminar un filtro, haga clic en el X icono.
    • Para ordenar los resultados, haga clic en Agregar en el Ordena sección de la interfaz. Puede especificar un campo por el que desea ordenar los resultados, las condiciones (lexicográfico, numérico, numeric_zero_as_max, o ipv4) y si se debe revertir el orden de clasificación.
      • Para agregar un nuevo método de clasificación, haga clic en Agregar.
      • Para eliminar un orden de clasificación, haga clic en el X icono.
    • Para limitar las columnas que se mostrarán, haga clic en Agregar en el Columnas sección de la interfaz. Luego, ingrese el número de columna en el Columna caja de texto.
      • Para agregar más columnas para mostrar, haga clic en Agregar.
      • Para eliminar una columna, haga clic en el X icono.
  5. Hacer clic Enviar.

A medida que modifica los valores de la función API, la interfaz actualiza el URL y Estructura de datos de llamadas a API entradas de las secciones.

Respuesta a la llamada a la API

Después de hacer clic Enviar, los retornos de la función API aparecen en el Respuesta a la llamada a la API sección de la interfaz. Puede ver los resultados en el Vista de árbol, Vista de tabla, y Vista sin procesar pestañas.

Nota:

  • los Vista sin procesar separa la respuesta de la llamada a la API de los encabezados HTTP.
  • los Vista de tabla puede no estar disponible para ciertos datos de función.

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *