機外機 API

API 描述

Defender for Endpoint 的外接裝置。

必要條件

支援的作業系統

  • 此 API 支援 Windows 11、Windows 10、版本 1703 及以上版本;Windows Server 2019 及以後版本;使用 Defender for Endpoint 的新統一代理程式時,會使用 Windows Server 2012 R2 和 Windows Server 2016。

限制

  • 此 API 的速率限制為每分鐘 100 次呼叫及每小時 1,500 次呼叫。
  • 此 API 不支援 macOS 或 Linux 裝置。
  • 執行離職 API 只會停止感測器服務的運行,但不會像離職腳本那樣從登錄檔中移除入職資訊。

權限

Microsoft 建議您使用權限最少的角色。 這有助於改善貴組織的安全性。 全域系統管理員是高度特殊權限角色,應僅在無法使用現有角色的緊急案例下使用。

使用使用者憑證取得令牌時:

  • 使用者必須被指派適當的角色。 欲了解更多資訊,請參閱: 權限選項

  • 使用者必須根據裝置群組設定取得該裝置的存取權。 欲了解更多資訊,請參閱: 建立與管理裝置群組

呼叫此 API 需要以下其中一項權限。 欲了解更多,包括如何選擇權限,請參閱 「端點 API 使用防禦器」

權限類型 權限 權限顯示名稱
應用程式 Machine.Offboard Offboard machine
委託 (工作或學校帳戶) Machine.Offboard Offboard machine

HTTP 要求

POST https://api.security.microsoft.com/api/machines/{id}/offboard

機器 ID 可以在你選擇裝置時的網址中找到。 通常,這是一個 40 位數的字母數字,可以在網址中找到。

要求標頭

名稱 類型 描述
授權 字串 持有人 {token}。 必要
Content-Type 字串 application/json。 必要

要求內文

在請求主體中,提供一個包含以下參數的 JSON 物件:

參數 Type 描述
留言 字串 留言以與行動相關聯。 必要

回應

若成功,此方法會在回應實體中回傳 200 - Created response 程式碼與 機器動作

範例

請求

以下是請求的範例。 如果沒有加入 JSON 註解,程式碼就會出 400錯。

POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
  "Comment": "Offboard machine by automation"
}