Обзор Вебмониторэкс API¶

Вебмониторэкс API обеспечивает взаимодействие компонентов системы Вебмониторэкс. Вы можете использовать методы Вебмониторэкс API для добавления, получения или изменения следующих сущностей:

уязвимости,
атаки,
инциденты,
пользователи,
клиенты,
WAF‑ноды и т.д.

Описание методов API доступно в справочнике API по ссылке https://apiconsole.ru1.wallarm.ru/.

Конечная точка API¶

Запросы API отправляются на https://api.wallarm.ru/.

Аутентификация в API¶

В запросах к Вебмониторэкс API необходимо передавать обязательные параметры аутентификации.

Для аутентификации используется токен, полученный после входа в ваш аккаунт Вебмониторэкс:

Войдите в ваш аккаунт Вебмониторэкс по ссылке.
Обновите справочник API по ссылке.
Перейдите к нужному методу → нажмите Try it out, введите значения параметров и выполните запрос.

Подход к разработке и документированию API в Вебмониторэкс¶

Вебмониторэкс использует подход API-first, поэтому поведение новых возможностей продукта описывается в коде API, затем в справочнике. Обычно публикация изменений в коде API и обновление справочника API выполняются одновременно, но в некоторых случаях изменения в коде не затрагивают документацию API. Описание некоторых методов API может быть опубликовано в справочнике позже или не опубликовано, если методы предназначены для внутреннего использования.

Справочник Вебмониторэкс API автоматически генерируется из swagger-файла с помощью инструмента Swagger UI. Справочник содержит описание методов API, параметров запроса и ответа и других атрибутов API. Вы можете выполнить любой описанный запрос через секцию Try it out справочника API.