ServicePilot SaaS Documentación



API

La API de ServicePilot permite enumerar fácilmente los recursos supervisados y permite que las aplicaciones externas y los agentes de ServicePilot interactúen con los datos de ServicePilot. El API se basa en REST con respuestas en formato JSON.

Gestión de recursos mediante el REST API

Para poder utilizar la API de REST, se requiere una clave de API. Obtener una clave API y usarla cuando llame a la interfaz REST.

Obtención de una clave API de ServicePilot

Abra la página Claves de la API para gestionar las claves de la API para los agentes de ServicePilot y la API REST. Se sugiere que utilice una llave API dedicada para la interfaz REST con privilegios de Lectura, Lectura y escritura o Lectura, escritura y eliminación, dependiendo del acceso requerido. Si esta clave está comprometida, puede ser eliminada sin afectar a la recopilación de datos del agente ServicePilot.

  1. Ingresa a ServicePilot usando una cuenta que pertenezca a un grupo con el nivel de acceso Admin.
  2. Abra la configuración Configuration icon
  3. Navegue hasta las clavesKeys menu item
  4. Crear y registrar una clave de API con la autorización necesaria Key list

Obtenga una lista de recursos

Para obtener una lista de todos los recursos, llama al método REST "GET" con una clave API que tenga el derecho Lectura. El comando curl que se muestra a continuación es una solicitud ejemplo utilizando la clave API "1000000000-000000-0000-0000-0000000000000000" del servidor ServicePilot. https://data.servicepilot.com.

curl -H "X-Api-Key: 10000000-0000-0000-0000-000000000000" -X GET "https://data.servicepilot.com/api/resources"

Obtener información sobre un recurso

Para obtener información sobre un recurso en particular, llama al método REST "GET" con una clave API que tenga el derecho Lectura. El comando curl que se muestra a continuación es una solicitud de ejemplo utilizando la clave API "1000000000-000000-0000-0000-0000000000000000" del servidor ServicePilot https://data.servicepilot.com. Obtendrá información sobre el recurso internalstatistics.

curl -H "X-Api-Key: 10000000-0000-0000-0000-000000000000" -X GET "https://data.servicepilot.com/api/resources/internalstatistics"

Añade un recurso

Para añadir un nuevo recurso, llama al método REST "PUT" con una clave API con permiso de Escritura. El comando curl que se muestra a continuación es una petición ejemplo utilizando la clave API "1000000000-000000-0000-0000-00000000000000" del servidor ServicePilot https://data.servicepilot.com. Creará un nuevo recurso llamado dns con los parámetros mostrados

No todos los parámetros son necesarios. Según el tipo de recurso, la lista de respuestas será diferente.

curl -H "X-Api-Key: 10000000-0000-0000-0000-000000000000" -X PUT "https://data.servicepilot.com/api/resources/dns" -d "{'package': 'appmon-dns', 'view': 'main', 'agent':'', 'agentpingsnmp':'', 'x': '150', 'y': '150', 'width': '30', 'height': '30', 'shape': 'image', 'picture': 'server.svg', 'backcolor': '#000000', 'borderwidth': '1', 'bordercolor': '#777777', 'borderstyle': 'solid', 'opacity': '100', 'backgroundcolorexist': 'true', 'html': '', 'policy': '', 'answers': {'dns_server_ip_address':'10.1.1.1','hostname_fqdn_to_resolve':'www.servicepilot.com','polling_interval':'60','timeout':'5'}}"

Para ver una lista de parámetros obligatorios y opcionales, vaya a la página de detalles del ServicePilot API.

  1. Utilizando una cuenta con privilegios de admin, inicie sesión en ServicePilot.
  2. Abra la configuración Configuration icon
  3. Acceder al elemento API API menu button
  4. Ponga Método en PUT y seleccione el Package deseado.

Los parámetros se presentarán en forma de lista y la solicitud de ejemplo cURL a la derecha.

Eliminar un recurso

Para borrar un recurso en particular, llame al método REST "BORRAR" usando una tecla API con la derecha Borrar. El comando curl que se muestra a continuación es una solicitud ejemplo utilizando la clave API "1000000000-000000-0000-0000-0000000000000000" del servidor ServicePilot. https://data.servicepilot.com. Eliminará el recurso internalstatistics.

curl -H "X-Api-Key: 10000000-0000-0000-0000-000000000000" -X DELETE "https://data.servicepilot.com/api/resources/internalstatistics"

Añadiendo recursos del Agente

Es posible agregar automáticamente recursos para ser monitoreados desde los agentes de Windows ServicePilot. El objetivo es automatizar la adición de recursos asociados a un agente tan pronto como el nuevo agente esté disponible.

Para determinar la sintaxis de la línea a añadir en la configuración del Agente, vaya a la página de detalles de la API de ServicePilot.

  1. Utilizando una cuenta con privilegios de admin, inicie sesión en ServicePilot.
  2. Abra la configuración Configuration icon
  3. Navegar a la API API menu button
  4. Ponga Método en PUT y seleccione el Package deseado..

Los parámetros se presentarán en una lista y el ejemplo Auto-provisioning request (Agent side) a la derecha.

Se pueden añadir recursos, uno por línea, en el cuadro de diálogo Auto-provisioning de la consola de configuración del agente ServicePilot.

Setup Console Auto-provisioning

Si se realiza una instalación automatizada del Agente ServicePiot, los datos de aprovisionamiento automático se almacenan bajo la siguiente clave de registro :

HKEY_LOCAL_MACHINE\SOFTWARE\ServicePilot Technologies\WindowsAgent\AutoProvisioning

Empiece Ahora