Перейти к содержанию

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

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

  • уязвимости,

  • атаки,

  • инциденты,

  • пользователи,

  • клиенты,

  • WAF‑ноды и т.д.

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

Справочник Вебмониторэкс API

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

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

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

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

  • Из интерфейса справочника API

  • С собственного клиента

Из интерфейса справочника API

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

  1. Войдите в ваш аккаунт Вебмониторэкс по ссылке.

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

  3. Перейдите к нужному методу > секция Try it out, введите значения параметров и выполните запрос.

С собственного клиента

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

При включении для пользователя SSO, аутентификации запросов к API через UUID и секретный ключ становится недоступной для данного пользователя. Детальная информация представлена в разделе SSO и аутентификация в API.

Для аутентификации используются ваши UUID и секретный ключ.

  1. Войдите в Консоль управления Вебмониторэкс → Настройки → Параметры для доступа к API.

  2. Cкопируйте значение UUID.

  3. Получите значение секретного ключа:

    • Если вам известно значение секретного ключа, вы можете продолжить использовать это значение, так как в интерфейсе отображается значение активного секретного ключа, но в зашифрованном виде.
    • Если вам неизвестно значение секретного ключа или ключ был утерян, сгенерируйте новый секретный ключ:

      1. Нажмите Обновить секретный ключ.
      2. Введите ваш пароль для подтверждения.
      3. Скопируйте полученное значение. Помните, что значение ключа отобразится только один раз.

      Переиспользование секретного ключа

      Кнопка Обновить секретный ключ генерирует новое значение секретного ключа и делает предыдущее значение невалидным. Для безопасного использования секретного ключа:

      • Сохраните значение ключа в безопасном месте. Значение секретного ключа больше нигде не отобразится.
      • Переиспользуйте сохраненное значение ключа во всех запросах к Вебмониторэкс API.
      • Если вы сгенерировали новое значение ключа, убедитесь, что предыдущее значение не используется на других клиентах API. Если предыдущее значение используется, замените его на новое.
  4. Передайте UUID и секретный ключ в запросе к Вебмониторэкс API:

    • UUID в заголовке запроса в параметре X-WallarmAPI-UUID
    • Секретный ключ в заголовке запроса в параметре X-WallarmAPI-Secret

Параметры для аутентификации в Вебмониторэкс API

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

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

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