Справочник по API интеграции для локальных консолей управления (общедоступная предварительная версия)
В этой статье перечислены API, поддерживаемые для интеграции Microsoft Defender для Интернета вещей с партнерскими службами.
Например, этот API в настоящее время реализован с помощью учебника . Интеграция ServiceNow с Microsoft Defender для Интернета вещейс помощью соединителя Graph ServiceNow для Defender для Интернета вещей.
Заметка
API интеграции предназначены для непрерывного выполнения и создания постоянно работающего потока данных, например для запроса новых данных за последние пять минут. API интеграции возвращают данные с меткой времени.
Чтобы просто запрашивать данные, используйте обычные api-интерфейсы, не связанные с интеграцией, для локальной консоли управления для запроса всех устройств или для конкретного датчика для запроса устройств только с этого датчика. Дополнительные сведения см. в справочнике по API Defender для Интернета вещей.
URI: /external/v3/integration/
устройства (создание и обновление устройств)
Этот API возвращает данные обо всех устройствах, которые были обновлены после заданной метки времени.
URI: /external/v3/integration/devices/<timestamp>
параметров URI
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
метки времени | Время начала, из которого возвращаются результаты, в миллисекундах из времени эпохи и часового пояса UTC. | /external/v3/integration/devices/1664781014000 |
Обязательно |
ПОЛУЧИТЬ
-
запроса
-
ответа
-
команды cURL
параметры запроса:
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
sensorId | Возвращает только устройства, видимые определенным датчиком. Используйте значение идентификатора из результатов датчиков (Получение датчиков) API. | 1 |
Необязательный |
notificationType | Определяет типы возвращаемых устройств. Поддерживаемые значения: - 0 : обновлены и новые устройства (по умолчанию). - 1 : только новые устройства. - 2 : только обновленные устройства. |
2 |
Необязательный |
страницы |
Определяет число, в котором начинается нумеровка страниц результатов. Например, 0 = первая страница — 0. Default = 0 |
0 |
Необязательный |
размера |
Определяет размер страницы. Default = 50 |
75 |
Необязательный |
подключения (получение подключений к устройству)
Этот API возвращает данные обо всех подключениях устройств, которые были обновлены после заданной метки времени.
URI: /external/v3/integration/connections/<timestamp>
параметров URI
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
метки времени | Время начала, из которого возвращаются результаты, в миллисекундах из времени эпохи и часового пояса UTC. | /external/v3/integration/devices/1664781014000 |
Обязательно |
ПОЛУЧИТЬ
-
запроса
-
ответа
-
команды cURL
параметры запроса:
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
страницы |
Определяет число, в котором начинается нумеровка страниц результатов. Например, 0 = первая страница — 0. Default = 0 |
0 |
Необязательный |
размера |
Определяет размер страницы. Default = 50 |
75 |
Необязательный |
устройство (получение сведений об устройстве)
Этот API возвращает данные о конкретном устройстве на определенный идентификатор устройства.
URI: /external/v3/integration/device/{deviceId}
ПОЛУЧИТЬ
-
запроса
-
ответа
-
команды cURL
параметры запроса:
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
deviceId | Идентификатор запрошенного устройства на локальной консоли управления | 1 |
Обязательно |
deleteddevices (Получение удаленных устройств)
Этот API возвращает список идентификаторов недавно удаленных устройств из указанной метки времени.
URI: /external/v3/integration/deleteddevices/
ПОЛУЧИТЬ
-
запроса
-
ответа
-
команды cURL
параметров URI
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
метки времени | Время начала, из которого возвращаются результаты, в миллисекундах из времени эпохи и часового пояса UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Обязательно |
датчики (получение датчиков)
Этот API возвращает список объектов датчиков для подключенных сетевых датчиков OT.
URI: /external/v3/integration/sensors/
ПОЛУЧИТЬ
-
запроса
-
ответа
-
команды cURL
URI: /sensors
Параметры запроса отсутствуют
devicecves (Получение CVES устройства)
Этот API возвращает список активных CVEs для всех устройств, которые были обновлены с момента предоставленной метки времени.
URI: /external/v3/integration/devicecves/
ПОЛУЧИТЬ
-
запроса
-
ответа
-
команды cURL
URI: /external/v3/integration/devicecves/<timestamp>
Параметры URI
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
метки времени | Время начала, из которого возвращаются результаты, в миллисекундах из времени эпохи и часового пояса UTC. | /external/v3/integration/devicecves/1664781014000 |
Обязательно |
Параметры запроса
Имя | Описание | Пример | Обязательный или необязательный |
---|---|---|---|
страницы |
Определяет число, в котором начинается нумеровка страниц результатов. |
0 = первая страница — 0. Default = 0 |
Необязательный |
размера |
Определяет размер страницы. | Default = 50 |
Необязательный |
sensorId | Отображает результаты определенного датчика, как определено заданным идентификатором датчика. | 1 |
Необязательный |
оценки |
Определяет минимальную оценку CVE, извлекаемую. Все результаты будут иметь оценку CVE, равную или больше заданного значения. | По умолчанию = 0 . |
Необязательный |
deviceIds | Разделенный запятыми список идентификаторов устройств, из которых требуется отобразить результаты. | Например, 1232,34,2,456 |
Необязательный |
Дальнейшие действия
Дополнительные сведения см. в следующем разделе: