內部部署管理主控台的整合 API 參考 (公開預覽版)
本文列出支援適用於 IoT 的 Microsoft Defender 與合作夥伴服務整合的 API。
例如,此 API 目前使用教學課程:將 ServiceNow 與適用於 IoT 的 Microsoft Defender 整合,針對適用於 IoT 的 Defender,透過 ServiceNow Service Graph 連接器進行實作。
注意
整合 API 是為了持續執行並建立持續執行的資料流,例如,查詢過去五分鐘內的新資料。 整合 API 會傳回帶有時間戳記的資料。
若只要查詢資料,請改用一般、非整合 API,讓內部部署管理主控台查詢所有裝置,或讓特定感應器只從該感應器查詢裝置。 如需詳細資訊,請參閱適用於 IoT 的 Defender API 參考。
URI: /external/v3/integration/
裝置 (建立和更新裝置)
此 API 會傳回指定時間戳記之後更新的所有裝置的相關資料。
URI: /external/v3/integration/devices/<timestamp>
URI 參數:
名稱 | 描述 | 範例 | 必要/選用 |
---|---|---|---|
timestamp | 從 Epoch 時間和 UTC 時區傳回結果的開始時間,以毫秒為單位。 | /external/v3/integration/devices/1664781014000 |
必要 |
GET
查詢參數:
名稱 | 描述 | 範例 | 必要/選用 |
---|---|---|---|
sensorId | 只傳回特定感應器看到的裝置。 使用來自 sensors (取得感應器) API 結果的識別碼值。 | 1 |
選擇性 |
notificationType | 決定要傳回的裝置類型。 支援的值包括: - 0 :更新的裝置和新裝置 (預設)。 - 1 :僅新裝置。 - 2 :僅更新的裝置。 |
2 |
選擇性 |
page | 定義結果頁碼編排開始的數字。 例如,0 = 第一頁為 0。 預設 = 0 |
0 |
選擇性 |
size | 定義頁面調整大小。 預設 = 50 |
75 |
選擇性 |
connections (取得裝置連線)
此 API 會傳回指定時間戳記之後更新的所有裝置線上的相關資料。
URI: /external/v3/integration/connections/<timestamp>
URI 參數:
名稱 | 描述 | 範例 | 必要/選用 |
---|---|---|---|
timestamp | 從 Epoch 時間和 UTC 時區傳回結果的開始時間,以毫秒為單位。 | /external/v3/integration/devices/1664781014000 |
必要 |
GET
查詢參數:
名稱 | 描述 | 範例 | 必要/選用 |
---|---|---|---|
page | 定義結果頁碼編排開始的數字。 例如,0 = 第一頁為 0。 預設 = 0 |
0 |
選擇性 |
size | 定義頁面調整大小。 預設 = 50 |
75 |
選擇性 |
device (取得裝置的詳細資料)
此 API 會根據指定的裝置識別碼傳回特定裝置的相關資料。
URI: /external/v3/integration/device/{deviceId}
GET
deleteddevices (取得已刪除的裝置)
此 API 會從提供的時間戳記傳回最近刪除裝置的識別碼清單。
URI: /external/v3/integration/deleteddevices/
GET
URI 參數:
名稱 | 描述 | 範例 | 必要/選用 |
---|---|---|---|
timestamp | 從 Epoch 時間和 UTC 時區傳回結果的開始時間,以毫秒為單位。 | /external/v3/integration/deleteddevices/1664781014000 |
必要 |
sensors (取得感應器)
此 API 會傳回已連線 OT 網路感應器的感應器物件清單。
URI: /external/v3/integration/sensors/
GET
devicecves (取得裝置 CVE)
此 API 會針對自提供的時間戳記以來更新的所有裝置,傳回作用中的 CVE 清單。
URI: /external/v3/integration/devicecves/
GET
URI: /external/v3/integration/devicecves/<timestamp>
URI 參數
名稱 | 描述 | 範例 | 必要/選用 |
---|---|---|---|
timestamp | 從 Epoch 時間和 UTC 時區傳回結果的開始時間,以毫秒為單位。 | /external/v3/integration/devicecves/1664781014000 |
必要 |
查詢參數
名稱 | 描述 | 範例 | 必要/選用 |
---|---|---|---|
page | 定義結果頁碼編排開始的數字。 |
0 = 第一頁為 0。 預設 = 0 |
選擇性 |
size | 定義頁面調整大小。 | 預設 = 50 |
選擇性 |
sensorId | 顯示特定感應器的結果,如指定的感應器識別碼所定義。 | 1 |
選擇性 |
score | 決定要擷取的最小 CVE 分數。 所有結果都會有等於或大於指定值的 CVE 分數。 | 預設值 = 0 。 |
選擇性 |
deviceIds | 您要顯示結果的裝置識別碼逗號分隔清單。 | 例如: 1232,34,2,456 |
選擇性 |
下一步
如需詳細資訊,請參閱