Советник по безопасности1: различия между версиями

Материал из Документация Ключ-АСТРОМ
Строка 1: Строка 1:


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


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


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
Первых компаний, внедривших
Этот запрос относится к раннему выпуску Adopter и может быть изменен несовместимым образом.
{| class="wikitable"
{| class="wikitable"
|ПОЛУЧИТЬ
|GET
|
|
* Удалось https: // {vash-domen} / e / {your-environment-id} / api / v2 / davis / securityAdvices
* Удалось https: // {vash-domen} / e / {your-environment-id} / api / v2 / davis / securityAdvices
* SaaS https: // {your-environment-id} .live.dynatrace.com / 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
* Environment АктивныйШлюз https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / davis / securityAdvices
|}
|}


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


== Параметры ==
== Параметры ==
Строка 29: Строка 25:
!Тип
!Тип
!Описание
!Описание
!В
!In
!необходимые
!необходимость
|-
|-
|managementZoneFilter
|managementZoneFilter
|нить
|string
|Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки.
|Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки.


Строка 44: Строка 40:
|-
|-
|nextPageKey
|nextPageKey
|нить
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.


Строка 54: Строка 50:
|-
|-
|размер страницы
|размер страницы
|целое число
|integer
|Количество советов по безопасности в одной полезной нагрузке.
|Количество советов по безопасности в одной полезной нагрузке.


Строка 86: Строка 82:
!Описание
!Описание
|-
|-
|общее количество
|totalCount
|целое число
|integer
|Общее количество записей в результате.
|Общее количество записей в результате.
|-
|-
|размер страницы
|размер страницы
|целое число
|integer
|Количество записей на странице.
|Количество записей на странице.
|-
|-
|nextPageKey
|nextPageKey
|нить
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.


Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
Может быть <code>null</code>.
|-
|-
|советы
|advices
|Совет по безопасности Дэвиса []
|DavisSecurityAdvice[]
|
| -
Может быть <code>null</code>.
|}
|}


Строка 112: Строка 111:
!Описание
!Описание
|-
|-
|название
|name
|нить
|string
|Название совета.
|Название совета.
|-
|-
|уязвимый компонент
|vulnerableComponent
|нить
|string
|Уязвимый компонент, к которому применяется совет.
|Уязвимый компонент, к которому применяется совет.
|-
|-
|технологии
|technology
|нить
|string
|Технология уязвимого компонента.
|Технология уязвимого компонента.


Строка 127: Строка 126:
|-
|-
|adviceType
|adviceType
|нить
|string
|Тип совета.
|Тип совета.


Элемент может содержать эти значения
Элемент может содержать эти значения
|-
|-
|критический
|critical
|нить[]
|string[]
|Идентификаторы проблем <code>critical</code>уровня безопасности, вызванных уязвимым компонентом.
|Идентификаторы проблем <code>critical</code>уровня безопасности, вызванных уязвимым компонентом.
|-
|-
|высокий
|high
|нить[]
|string[]
|Идентификаторы проблем <code>high</code>уровня безопасности, вызванных уязвимым компонентом.
|Идентификаторы проблем <code>high</code>уровня безопасности, вызванных уязвимым компонентом.
|-
|-
|средний
|medium
|нить[]
|string[]
|Идентификаторы проблем <code>medium</code>уровня безопасности, вызванных уязвимым компонентом.
|Идентификаторы проблем <code>medium</code>уровня безопасности, вызванных уязвимым компонентом.
|-
|-
|низкий
|low
|нить[]
|string[]
|Идентификаторы проблем <code>low</code>уровня безопасности, вызванных уязвимым компонентом.
|Идентификаторы проблем <code>low</code>уровня безопасности, вызванных уязвимым компонентом.
|-
|-
|никто
|now
|нить[]
|string[]
|Идентификаторы проблем <code>none</code>уровня безопасности, вызванных уязвимым компонентом.
|Идентификаторы проблем <code>none</code>уровня безопасности, вызванных уязвимым компонентом.
|}
|}

Версия 10:51, 11 марта 2022

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

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

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

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

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

GET
  • Удалось https: // {vash-domen} / e / {your-environment-id} / api / v2 / davis / securityAdvices
  • SaaS https: // {your-environment-id} .live.dynatrace.com / api / v2 / davis / securityAdvices.
  • Environment АктивныйШлюз https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / davis / securityAdvices

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

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

Параметры

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

Вы можете указать несколько критериев, разделенных запятыми (например, names("myMz"),ids("9130632296508575249")).

запрос по желанию
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Если nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

запрос по желанию
размер страницы integer Количество советов по безопасности в одной полезной нагрузке.

Максимально допустимый размер страницы - 500.

Если не установлен, используется 5.

запрос по желанию

Ответ

Коды ответов

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

Тело ответа

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

DavisSecurityAdviceList объект

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

Элемент Тип Описание
totalCount integer Общее количество записей в результате.
размер страницы integer Количество записей на странице.
nextPageKey string Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Может быть null.

advices DavisSecurityAdvice[] -

Может быть null.

DavisSecurityAdvice объект

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

Элемент Тип Описание
name string Название совета.
vulnerableComponent string Уязвимый компонент, к которому применяется совет.
technology string Технология уязвимого компонента.

Элемент может содержать эти значения

adviceType string Тип совета.

Элемент может содержать эти значения

critical string[] Идентификаторы проблем criticalуровня безопасности, вызванных уязвимым компонентом.
high string[] Идентификаторы проблем highуровня безопасности, вызванных уязвимым компонентом.
medium string[] Идентификаторы проблем mediumуровня безопасности, вызванных уязвимым компонентом.
low string[] Идентификаторы проблем lowуровня безопасности, вызванных уязвимым компонентом.
now string[] Идентификаторы проблем 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"
      ]
    }
  ]
}
Источник — https://doc.ruscomtech.ru/index.php?title=Советник_по_безопасности1&oldid=850