Пожалуйста, откройте билет поддержки, чтобы получить доступ к API с ваших IP-адресов.

Этот раздел помогает разработчикам программного обеспечения, которые хотят разрабатывать приложения с помощью инструментов мониторинга Dotcom-Monitor. API обеспечивает взаимодействие с веб-сайтом Dotcom-Monitor с помощью простых запросов HTTP/HTTPS. Пользователи API могут создавать свои собственные скрипты или приложения для взаимодействия с настройками и просмотра контролируемых данных в собственной настраиваемой среде. Практически каждый аспект функциональности сервиса Dotcom-Monitor можно управлять. Используя вызовы API, разработчики могут создавать и удалять устройства и задачи, откладывать и начинать их, создавать и управлять фильтрами и планировщиками групп оповещения, получать информацию о статусе плюс многие другие варианты.

Существует несколько способов просмотра и взаимодействия с данными мониторинга за пределами интерфейса веб-сайта, включая использование канала XML для потребления данных и взаимодействие с API для мониторинга и обновления установленных агентов мониторинга. С помощью XML-канала разработчики могут подписаться на разыскиваемые данные и представить их в своем собственном формате, используя свои собственные пользовательские отчеты. Подробнее об этом можно усмотреть с помощью инструмента службы отчетности XML (XRS).

Пользовательский коллектор API

Отдельный API MetricsView представляет собой набор методов для загрузки любых метрик из любого источника, независимо от платформы в Dotcom-Monitor inc. для дальнейшей обработки и анализа.

API Dotcom-Monitor разбит на 10 типов ресурсов:

  • Платформа: Все задачи мониторинга подпадают под одну из пяти различных платформ.
  • Устройства: Мониторинг устройства является организованным “набором” задач мониторинга, который содержит либо одну задачу мониторинга, последовательность задач мониторинга, сценарий мониторинга, который включает в себя задачи, или сочетание всех трех.
  • Задачи: Задача состоит из любого действия по мониторингу, например мониторинга цели (URL, почтовый сервер, FTP Server и т.д.).
  • Частота: Определяет, как часто будут выполняться сеансы мониторинга.
  • Планировщик: Планировщик подробно, когда задача будет или не будет запущена.
  • Местонахождение: Местоположение мониторинга, доступное в сети мониторинга Dotcom-Monitor по всему миру.
  • Группа оповещения: Настройка группы помещает получателей отчета и/или оповещения в группу. Каждый получатель в группе может иметь уникальный шаблон оповещения.
  • Шаблон оповещения: Шаблон определяет формат оповещений.
  • Фильтр: Фильтр – это набор правил, определяющих, как обрабатываются и отображаются ответы мониторинга.
  • Аудит: Предоставляет историческую информацию о каждой модификации учетной записи.

Добавление уникального идентификатора интеграции

Для настройки интеграции с Dotcom-Monitor необходимо иметь доступ к активной учетной записи Dotcom-Monitor и создать уникальный идентификатор Web API для использования в запросе на аутентификацию:

  1. Войдите в учетную запись Dotcom-Monitor.
  2. В Dotcom-Monitor создайте интеграционный UID под настроенной > интеграцией.

Перед любым запросом API необходимо проверить подлинность в Dotcom-Monitor. Срок действия аутентификации истекает через 60 секунд после бездействия.

В таблице ниже показано, какой тип запроса и действие поддерживаются каждым типом ресурса.

Тип ресурсов Метод запроса URI (ы) описание
платформа Получить /платформы Обратный список доступных платформ
устройство Получить /устройства/{platform} Получите список устройств по платформе.
Получить /устройство/{deviceId} Получить информацию об устройстве
Поместить /устройства?verb-PUT Создание нового устройства
класть /устройства
Поместить /устройство/ {deviceId} /DisableAlert/ Отключение оповещений
Поместить /устройство/{deviceId} Редактировать устройство
Поместить /устройство/ {deviceId} ?verb’delete Удаление устройства
удалить /устройство/{deviceId}
задача Получить /устройство/ {deviceid} /задачи Получить список задач под устройством
Поместить /задачи?verb-PUT Создание новой задачи
класть /задачи
Получить /задача/{TaskId} Получить информацию о задаче
Поместить /задача/{TaskId} Задача редактирования
Поместить /задача/ {TaskId} ?verb’delete Удаление задачи
удалить /задача/{TaskId}
Частота Получить /частоты/{platform_name} Получить доступ freq. по платформе.
планировщик Получить /Планировщики Получить список планировщиков
Получить /Расписание/{Scheduler_ID} Получить конкретную информацию планировщик
Поместить /Планировщики?вербе-ПУТ Создание нового планировщика
класть Планировщики
Поместить /Расписание/идентификатор планировщика Редактировать планировщик
Поместить /Расписание/ {Scheduler_Id} ?verb’delete Удалить планировщик
удалить /Расписание/{Scheduler_Id}
Расположение Получить /локации/{platform_name} Получить список доступных мест
Группа оповещения Получить /группы Получить список групп оповещения
Поместить /группы?verb-PUT/groups Создание группы оповещения
класть группы/группы
Получить /Группа/{Group_ID} Получить информацию о группе оповещения
Поместить /Группа/{Group_ID} Редактировать группу оповещения
Поместить /Группа/ {Group_Id} ?verb’delete Удалить группу
удалить Группа/{Group_Id}
Шаблон оповещения Получить /шаблоны Получить список шаблонов оповещения
Поместить /шаблоны?verb-PUT/templates Создание нового шаблона оповещения
класть /шаблоны/шаблоны
Получить /шаблон/{Template_ID} Получить информацию о шаблоне оповещения
Поместить /шаблон/{Template_ID} Редактировать шаблон оповещения
Поместить /шаблон/ {Template_Id} ?verb’delete Удалить шаблон
удалить /шаблон/{Template_Id}
фильтр Получить /фильтры Получить список фильтров
Поместить /фильтры?verb-PUT Создание нового фильтра
класть /фильтры
Получить /фильтр/{filter_ID} Получить конкретную информацию о фильтре
Поместить /фильтр/{filter_ID} Редактировать фильтр
Поместить /фильтр/ {filter_ID} ?verb’delete Удалить фильтр
удалить /фильтр/{filter_ID}
ревизия Получить /аудит/список Получить список проверенных объектов для текущего пользователя за последние 24h.
Получить /аудит/объект/образец ID Получить содержимое аудита для конкретного идентификатора
Поместить /аудит/список Получить отфильтрованный список проверенных объектов.