將機器 API 下線
適用於：
想要體驗適用於端點的 Microsoft Defender 嗎? 注册免費試用版。
注意事項
如果您是美國政府客戶，請使用美國政府客戶 適用於端點的 Microsoft Defender 中所列的 URI。
提示
為了獲得更好的效能，您可以使用更接近您地理位置的伺服器：
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
API 描述
從適用於端點的Defender將裝置離線。
限制
此 API 的速率限制為每分鐘 100 次呼叫，每小時 1,500 次呼叫。
注意事項
此頁面著重於透過 API 執行機器動作。 如需透過 適用於端點的 Microsoft Defender 回應動作功能的詳細資訊，請參閱在計算機上採取回應動作。
注意事項
- 在 windows Server 2019 和更新版本上，Windows 11、Windows 10、版本 1703 和更新版本支援此 API;在使用適用於端點的 Defender 的新整合代理程式時，Windows Server 2012 R2 和 Windows Server 2016 上支援此 API。
- macOS 或 Linux 裝置不支援此 API。
- 執行離線 API 只會阻止感測器服務執行，但不會從登錄中移除上線資訊，就像離線腳本一樣。
權限
呼叫此 API 需要下列其中一個許可權。 若要深入瞭解，包括如何選擇許可權，請 參閱使用適用於端點的 Defender API
| 許可權類型 | 權限 | 許可權顯示名稱 |
|---|---|---|
| 應用程式 | Machine.Offboard |
Offboard machine |
| 委派 (公司或學校帳戶) | Machine.Offboard |
Offboard machine |
重要事項
Microsoft 建議您使用權限最少的角色。 這有助於改善貴組織的安全性。 全域系統管理員是高度特殊權限角色，應僅在無法使用現有角色的緊急案例下使用。
使用使用者認證取得權杖時：
用戶必須獲指派適當的角色 (請參閱權 限選項) 。
用戶必須能夠根據裝置群組設定存取裝置。 如需詳細資訊，請 參閱建立和管理裝置群組。
適用於端點的Defender方案1和方案2支援裝置群組建立。
HTTP 要求
POST https://api.security.microsoft.com/api/machines/{id}/offboard
當您選取裝置時，可以在 URL 中找到電腦識別碼。 一般而言，它是可在URL中找到的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"
}
提示
想要深入了解? Engage 技術社群中的Microsoft安全性社群：適用於端點的 Microsoft Defender 技術社群。