API советника по безопасности Davis

Davis Advisor Security API перечисляет рекомендацию Davis , связанную с открытой и заглушены проблемами безопасности .

Вы можете ограничить вывод, используя разбиение на страницы:

Укажите количество результатов на странице в параметре запроса pageSize .
Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.

Запрос создает application/jsonполезную нагрузку.

Первых компаний, внедривших

Этот запрос относится к раннему выпуску Adopter и может быть изменен несовместимым образом.

ПОЛУЧИТЬ	Удалось https: // {vash-domen} / e / {your-environment-id} / api / v2 / davis / securityAdvices SaaS https: // {your-environment-id} .live.dynatrace.com / api / v2 / davis / securityAdvices. Среда ActiveGate https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / davis / securityAdvices

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

Чтобы выполнить этот запрос, вам необходимо разрешение на чтение проблем безопасности ( securityProblems.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

Параметры

Параметр	Тип	Описание	В	необходимые
managementZoneFilter	нить	Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки. Идентификатор зоны управления: ids («mzId-1», «mzId-2»). Названия зон управления: наименования («МЗ-1», «МЗ-2»). Вы можете указать несколько критериев, разделенных запятыми (например, `names("myMz"),ids("9130632296508575249")`).	запрос	по желанию
nextPageKey	нить	Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Если nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.	запрос	по желанию
размер страницы	целое число	Количество советов по безопасности в одной полезной нагрузке. Максимально допустимый размер страницы - 500. Если не установлен, используется 5.	запрос	по желанию

Ответ

Коды ответов

Код	Описание
200	Успех

Тело ответа

Параметры ответа

DavisSecurityAdviceList объект

Список советов от советника по безопасности Дэвиса.

Элемент	Тип	Описание
общее количество	целое число	Общее количество записей в результате.
размер страницы	целое число	Количество записей на странице.
nextPageKey	нить	Курсор для следующей страницы результатов. Имеет значение `null`на последней странице. Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
советы	Совет по безопасности Дэвиса []

DavisSecurityAdvice объект

Совет по безопасности от советника по безопасности Дэвиса.

Элемент	Тип	Описание
название	нить	Название совета.
уязвимый компонент	нить	Уязвимый компонент, к которому применяется совет.
технологии	нить	Технология уязвимого компонента. Элемент может содержать эти значения
adviceType	нить	Тип совета. Элемент может содержать эти значения
критический	нить[]	Идентификаторы проблем `critical`уровня безопасности, вызванных уязвимым компонентом.
высокий	нить[]	Идентификаторы проблем `high`уровня безопасности, вызванных уязвимым компонентом.
средний	нить[]	Идентификаторы проблем `medium`уровня безопасности, вызванных уязвимым компонентом.
низкий	нить[]	Идентификаторы проблем `low`уровня безопасности, вызванных уязвимым компонентом.
никто	нить[]	Идентификаторы проблем `none`уровня безопасности, вызванных уязвимым компонентом.

Модель JSON

Тело ответа

{
  "totalCount": 1,
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ==",
  "advices": [
    {
      "name": "string",
      "vulnerableComponent": "string",
      "technology": "DOTNET",
      "adviceType": "UPGRADE",
      "critical": [
        "string"
      ],
      "high": [
        "string"
      ],
      "medium": [
        "string"
      ],
      "low": [
        "string"
      ],
      "none": [
        "string"
      ]
    }
  ]
}