オフボード マシン API
適用対象:
Defender for Endpoint を試す場合は、 無料試用版にサインアップしてください。
注:
米国政府機関のお客様は、 Microsoft Defender for Endpoint for US Government のお客様に記載されている 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 for Endpoint からのオフボード デバイス。
制限事項
この API のレート制限は、1 分あたり 100 呼び出しと 1 時間あたり 1,500 呼び出しです。
注:
このページでは、API を使用したマシン アクションの実行に焦点を当てます。 Microsoft Defender for Endpoint を使用 した応答アクション 機能の詳細については、「コンピューターで応答アクションを実行する」を参照してください。
注:
- この API は、Windows 11、Windows 10、バージョン 1703 以降でサポートされています。Windows Server 2019 以降。および Windows Server 2012 R2 および Windows Server 2016 で 、Defender for Endpoint 用の新しい統合エージェントを使用する場合。
- この API は、macOS または Linux デバイスではサポートされていません。
- オフボード API を実行すると、センサー サービスの実行は停止されますが、オフボード スクリプトのようにレジストリからオンボード情報は削除されません。
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法など、詳細については、「Defender for Endpoint API を使用する」を参照してください。
アクセス許可の種類 | アクセス許可 | アクセス許可の表示名 |
---|---|---|
アプリケーション | Machine.Offboard |
Offboard machine |
委任 (職場または学校のアカウント) | Machine.Offboard |
Offboard machine |
重要
Microsoft では、アクセス許可が可能な限りで少ないロールを使用することをお勧めします。 これにより、組織のセキュリティが向上します。 グローバル管理者は高い特権を持つロールであり、既存のロールを使用できない場合の緊急時に限定する必要があります。
注:
ユーザー資格情報を使用してトークンを取得する場合:
- ユーザーにはグローバル管理者ロールが必要です。
- ユーザーは、デバイス グループの設定に基づいてデバイスにアクセスできる必要があります。 詳細については、「 デバイス グループの作成と管理」を参照してください。
デバイス グループの作成は、Defender for Endpoint プラン 1 とプラン 2 でサポートされています。
HTTP 要求
POST https://api.security.microsoft.com/api/machines/{id}/offboard
デバイスを選択すると、マシン ID が URL に表示されます。 一般に、URL に記載されている 40 桁の英数字です。
要求ヘッダー
名前 | 型 | 説明 |
---|---|---|
Authorization | String | ベアラー {token}。 必須。 |
Content-Type | string | application/json. 必須。 |
要求本文
要求本文で、JSON オブジェクトに次のパラメーターを指定します。
パラメーター | 型 | 説明 |
---|---|---|
コメント | 文字列 | アクションに関連付けるコメント。 必須。 |
応答
成功した場合、このメソッドは応答本文 200 - Created response
コードと Machine Action を 返します。
例
要求
要求の例を次に示します。 JSON コメントが追加されていない場合は、コード 400
でエラーが発生します。
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
"Comment": "Offboard machine by automation"
}
ヒント
さらに多くの情報を得るには、 Tech Community 内の Microsoft Security コミュニティ (Microsoft Defender for Endpoint Tech Community) にご参加ください。