Esta sección ayuda a los desarrolladores de software que desean desarrollar aplicaciones mediante el uso de herramientas de supervisión de Dotcom-Monitor. API permite la interacción con el sitio web de Dotcom-Monitor mediante programación a través de solicitudes HTTP/HTTPS simples. Los usuarios de API pueden crear sus propios scripts o aplicaciones personalizados para interactuar con la configuración y ver los datos supervisados en su propio entorno personalizado. Se pueden administrar casi todos los aspectos de la funcionalidad del servicio Dotcom-Monitor. Mediante las llamadas a la API, los desarrolladores pueden crear y eliminar dispositivos y tareas, posponerlos e iniciarlos, crear y administrar filtros y programadores de grupos de alertas, obtener información de estado y muchas otras opciones.
Hay varias maneras de ver e interactuar con los datos de supervisión más allá de la interfaz del sitio web, incluido el uso de la fuente XML para consumir datos e interactuar con la API para supervisar y actualizar los agentes de supervisión instalados. Con la fuente XML, los desarrolladores pueden suscribirse a los datos deseados y presentarlos en su propio formato utilizando sus propios informes personalizados.
La API de Dotcom-Monitor se divide en 10 tipos de recursos:
- Plataforma: Todas las tareas de supervisión se dividen en una de las cinco plataformas diferentes.
- Dispositivos: Un dispositivo supervisado es un “conjunto” organizado de tareas de supervisión que contiene una sola tarea de supervisión, una secuencia de tareas de supervisión, un script de supervisión que incluye tareas o una combinación de las tres.
- Tareas: Una tarea es cualquier actividad de supervisión única, como la supervisión de un destino (URL, servidor de correo, servidor FTP, etc.).
- Frecuencia: Define la frecuencia con la que se ejecutarán las sesiones de supervisión.
- Programador: Un programador detalla cuándo se ejecutará o no una tarea.
- Ubicación: Una ubicación de monitoreo disponible dentro de la red de monitoreo de Dotcom-Monitor en todo el mundo.
- Grupo de alertas: La configuración de un grupo coloca a los destinatarios de un informe o alerta en un grupo. Cada destinatario del grupo puede tener una plantilla de alerta única.
- Plantilla de alerta: la plantilla define el formato de alertas.
- Filtro: Un filtro es un conjunto de reglas que determinan cómo se procesan y muestran las respuestas de supervisión.
- Auditoría: proporciona información histórica sobre todas y cada una de las modificaciones de la cuenta.
La tabla siguiente muestra qué tipo de solicitud y acción admite cada tipo de recurso.
Tipo de recurso | Método de solicitud | URI(s) | Descripción |
---|---|---|---|
Plataforma | Obtener | /plataformas | Lista de devoluciones de las plataformas disponibles |
Dispositivo | Obtener | /dispositivos/{platform} | Obtener lista de dispositivos por plataforma. |
Obtener | /dispositivo/{deviceId} | Obtener información del dispositivo | |
Exponer | /devices?verb-PUT | Crear nuevo dispositivo | |
Poner | /dispositivos | ||
Exponer | /device/ {deviceId} /DisableAlert/ | Desactivar alertas | |
Exponer | /dispositivo/{deviceId} | Editar dispositivo | |
Exponer | /device/ {deviceId} ?verb-delete | Eliminar dispositivo | |
Eliminar | /dispositivo/{deviceId} | ||
Tarea | Obtener | /device/ {deviceid} /tasks | Obtener una lista de tareas bajo un dispositivo |
Exponer | /tasks?verb-PUT | Crear nueva tarea | |
Poner | /tasks | ||
Obtener | /tarea/{TaskId} | Obtener información de la tarea | |
Exponer | /tarea/{TaskId} | Editar tarea | |
Exponer | /task/ {TaskId} ?verb-delete | Eliminar tarea | |
Eliminar | /tarea/{TaskId} | ||
Frecuencia | Obtener | /frecuencias/{platform_name} | Obtener freq disponible. por plataforma. |
Programador | Obtener | /schedulers | Obtener una lista de programadores |
Obtener | /Programador/{Scheduler_ID} | Obtener información específica del programador | |
Exponer | /schedulers?verb-PUT | Crear un nuevo programador | |
Poner | Programadores | ||
Exponer | /scheduler/- ID del programador | Editar programador | |
Exponer | /Scheduler/ {Scheduler_Id} ?verb-delete | Eliminar programador | |
Eliminar | /Programador/{Scheduler_Id} | ||
Ubicación | Obtener | /ubicaciones/{platform_name} | Obtener una lista de las ubicaciones disponibles |
Grupo de alertas | Obtener | /grupos | Obtener una lista de grupos de alertas |
Exponer | /groups?verb-PUT/groups | Crear grupo de alertas | |
Poner | grupos/grupos | ||
Obtener | /Grupo/{Group_ID} | Obtener información del grupo de alertas | |
Exponer | /Grupo/{Group_ID} | Editar grupo de alertas | |
Exponer | /Group/ {Group_Id} ?verb-delete | Eliminar grupo | |
Eliminar | Grupo/{Group_Id} | ||
Plantilla de alerta | Obtener | /templates | Obtener una lista de plantillas de alertas |
Exponer | /templates?verb-PUT/templates | Crear una nueva plantilla de alerta | |
Poner | /templates/templates | ||
Obtener | /plantilla/{Template_ID} | Obtener información de la plantilla de alerta | |
Exponer | /plantilla/{Template_ID} | Editar plantilla de alerta | |
Exponer | /template/ {Template_Id} ?verb-delete | Eliminar plantilla | |
Eliminar | /plantilla/{Template_Id} | ||
Filtro | Obtener | /filters | Obtener una lista de filtros |
Exponer | /filters?verb-PUT | Crear nuevo filtro | |
Poner | /filters | ||
Obtener | /filtro/{filter_ID} | Obtener información específica del filtro | |
Exponer | /filtro/{filter_ID} | Editar filtro | |
Exponer | /filter/ {filter_ID} ?verb-delete | Eliminar filtro | |
Eliminar | /filtro/{filter_ID} | ||
Auditoría | Obtener | /audit/list | Obtenga objetos auditados de lista para el usuario actual durante las últimas 24 horas. |
Obtener | /audit/objeto/-ejemplo ID- | Obtener el contenido de la auditoría para el ID en particular | |
Exponer | /audit/list | Obtenga una lista filtrada de objetos auditados. |