共用方式為


內部部署管理主控台的整合 API 參考 (公開預覽)

本文列出支援整合適用於IoT Microsoft Defender 與合作夥伴服務的 API。

例如,此 API 目前使用 教學課程實作:透過適用於IoT的ServiceNow Service Graph 連接器,將 ServiceNow 與適用於IoT的 Defender Microsoft Defender 整合

注意

整合 API 旨在持續執行並建立持續執行的數據流,例如查詢過去五分鐘內的新數據。 整合 API 會傳回時間戳的數據。

若要直接查詢數據,請改用一般的非整合 API,讓內部部署管理主控台查詢所有裝置,或讓特定感測器只從該感測器查詢裝置。 如需詳細資訊,請參閱 適用於IoT的Defender API 參考

URI/external/v3/integration/

裝置 (建立與更新裝置)

此 API 會傳回指定時間戳之後更新之所有裝置的相關數據。

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

URI 參數

名字 描述 必要/ 選擇性
時間戳 Epoch 時間 和 UTC 時區傳回結果的開始時間,以毫秒為單位。 /external/v3/integration/devices/1664781014000 必填

獲取

查詢參數

名字 描述 必要/ 選擇性
sensorId 只傳回特定感測器所見的裝置。 使用來自 感測器結果的標識碼值(取得感測器) API。 1 自選
notificationType 決定要傳回的裝置類型。 支援的值包括:
- 0:更新和新裝置 (預設值)。
- 1:僅限新裝置。
- 2:僅更新的裝置。
2 自選
頁面 定義結果頁碼開始的位置。 例如,0= 第一頁是 0
預設值 = 0
0 自選
大小 定義頁面大小調整。 預設值 = 50 75 自選

線上 (取得裝置連線)

此 API 會傳回指定時間戳之後更新之所有裝置連線的相關數據。

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

URI 參數

名字 描述 必要/ 選擇性
時間戳 Epoch 時間 和 UTC 時區傳回結果的開始時間,以毫秒為單位。 /external/v3/integration/devices/1664781014000 必填

獲取

查詢參數

名字 描述 必要/ 選擇性
頁面 定義結果頁碼開始的位置。 例如,0= 第一頁是 0
預設值 = 0
0 自選
大小 定義頁面大小調整。 預設值 = 50 75 自選

裝置 (取得裝置的詳細資料)

此 API 會根據指定的裝置標識碼傳回特定裝置的相關數據。

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

獲取

查詢參數

名字 描述 必要/ 選擇性
deviceId 內部部署管理控制臺上要求裝置的標識碼 1 必填

deleteddevices (取得已刪除的裝置)

此 API 會從提供的時間戳傳回最近刪除之裝置的標識碼清單。

URI/external/v3/integration/deleteddevices/

獲取

URI 參數

名字 描述 必要/ 選擇性
時間戳 Epoch 時間 和 UTC 時區傳回結果的開始時間,以毫秒為單位。 /external/v3/integration/deleteddevices/1664781014000 必填

感測器 (取得感測器)

此 API 會傳回已連線 OT 網路感測器的感測器物件清單。

URI/external/v3/integration/sensors/

獲取

URI/sensors

沒有查詢參數

devicecves (取得裝置 CVE)

此 API 會針對自提供時間戳以來更新的所有裝置,傳回使用中 CVE 的清單。

URI/external/v3/integration/devicecves/

獲取

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

URI 參數

名字 描述 必要/ 選擇性
時間戳 Epoch 時間 和 UTC 時區傳回結果的開始時間,以毫秒為單位。 /external/v3/integration/devicecves/1664781014000 必填

查詢參數

名字 描述 必要/ 選擇性
頁面 定義結果頁碼開始的位置。 0= 第一頁 0
預設值 = 0
自選
大小 定義頁面大小調整。 預設值 = 50 自選
sensorId 顯示特定感測器的結果,如指定的感測器標識碼所定義。 1 自選
分數 決定要擷取的最低 CVE 分數。 所有結果都會有等於或大於指定值的 CVE 分數。 預設值 = 0 自選
deviceIds 您想要顯示結果的裝置識別碼逗號分隔清單。 例如:1232,34,2,456 自選

後續步驟

如需詳細資訊,請參閱: