Справочник по API интеграции для локальных консолей управления (общедоступная предварительная версия)

В этой статье перечислены API, поддерживаемые для интеграции Microsoft Defender для Интернета вещей со службами партнеров.

Например, этот API в настоящее время реализуется с помощью учебника. Интеграция ServiceNow с Microsoft Defender для Интернета вещей с помощью соединителя ServiceNow Service Graph Connector для Defender для Интернета вещей.

Примечание

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

Чтобы просто запросить данные, используйте вместо этого обычные API, не связанные с интеграцией, чтобы локальный консоль управления запрашивать все устройства, или конкретный датчик, чтобы запрашивать устройства только с этого датчика. Дополнительные сведения см. в справочнике по API Defender для Интернета вещей.

URI: /external/v3/integration/

devices (Создание и обновление устройств)

Этот API возвращает данные обо всех устройствах, которые были обновлены после заданной метки времени.

URI: /external/v3/integration/devices/<timestamp>

Параметры URI:

Имя Описание Пример Обязательный или необязательный
timestamp Время начала, с которого возвращаются результаты, в миллисекундах от времени эпохи и в часовом поясе UTC. /external/v3/integration/devices/1664781014000 Обязательно

GET

Параметры запроса:

Имя Описание Пример Обязательный или необязательный
sensorId Возвращает только устройства, видимые определенным датчиком. Используйте значение идентификатора из результатов API датчиков (Получение датчиков). 1 Необязательно
notificationType Определяет типы возвращаемых устройств. Допустимые значения:
- 0: обновленные и новые устройства (по умолчанию).
- 1: только новые устройства.
- 2: только обновленные устройства.
2 Необязательно
страница Определяет номер, с которого начинается нумеровка результирующих страниц. Например, 0= первая страница имеет значение 0.
По умолчанию = 0
0 Необязательно
size Определяет размер страницы. По умолчанию = 50 75 Необязательно

connections (Получение подключений устройств)

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

URI: /external/v3/integration/connections/<timestamp>

Параметры URI:

Имя Описание Пример Обязательный или необязательный
timestamp Время начала, с которого возвращаются результаты, в миллисекундах от времени эпохи и в часовом поясе UTC. /external/v3/integration/devices/1664781014000 Обязательно

GET

Параметры запроса:

Имя Описание Пример Обязательный или необязательный
страница Определяет номер, с которого начинается нумеровка результирующих страниц. Например, 0= первая страница имеет значение 0.
По умолчанию = 0
0 Необязательно
size Определяет размер страницы. По умолчанию = 50 75 Необязательно

device (Получение сведений об устройстве)

Этот API возвращает данные о конкретном устройстве для заданного идентификатора устройства.

URI: /external/v3/integration/device/{deviceId}

GET

Параметры запроса:

Имя Описание Пример Обязательный или необязательный
deviceId Идентификатор запрошенного устройства в локальной консоль управления 1 Обязательно

deleteddevices (Получение удаленных устройств)

Этот API возвращает список идентификаторов недавно удаленных устройств из предоставленной метки времени.

URI: /external/v3/integration/deleteddevices/

GET

Параметры URI:

Имя Описание Пример Обязательный или необязательный
timestamp Время начала, с которого возвращаются результаты, в миллисекундах от времени эпохи и часового пояса UTC. /external/v3/integration/deleteddevices/1664781014000 Обязательно

датчики (Получение датчиков)

Этот API возвращает список объектов датчиков для подключенных сетевых датчиков OT.

URI: /external/v3/integration/sensors/

GET

URI: /sensors

Параметры запроса отсутствуют

devicecves (получение cves устройства)

Этот API возвращает список активных cves для всех устройств, которые были обновлены с момента предоставленной метки времени.

URI: /external/v3/integration/devicecves/

GET

URI: /external/v3/integration/devicecves/<timestamp>

Параметры универсального кода ресурса (URI)

Имя Описание Пример Обязательный или необязательный
timestamp Время начала, с которого возвращаются результаты, в миллисекундах от времени эпохи и в часовом поясе UTC. /external/v3/integration/devicecves/1664781014000 Обязательно

Параметры запроса

Имя Описание Пример Обязательный или необязательный
страница Определяет номер, с которого начинается нумеровка результирующих страниц. 0= первая страница — 0.
По умолчанию = 0
Необязательно
size Определяет размер страницы. По умолчанию = 50 Необязательно
sensorId Показывает результаты определенного датчика, как определено заданным идентификатором датчика. 1 Необязательно
score Определяет минимальную оценку CVE для получения. Все результаты будут иметь оценку CVE, равную или превышающую заданное значение. По умолчанию = 0. Необязательно
идентификаторы устройства Разделенный запятыми список идентификаторов устройств, из которых требуется отобразить результаты. Пример: 1232,34,2,456 Необязательно

Дальнейшие действия

Дополнительные сведения см. в разделе: