title | description | ms.service | ms.author | author | ms.localizationpriority | manager | audience | ms.collection | ms.topic | ms.subservice | ms.custom | search.appverid | ms.date | |||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Start Investigation API |
Use this API to start investigation on a device. |
defender-endpoint |
siosulli |
siosulli |
medium |
deniseb |
ITPro |
|
reference |
reference |
api |
met150 |
12/18/2020 |
[!INCLUDE Microsoft Defender XDR rebranding]
Applies to:
Want to experience Defender for Endpoint? Sign up for a free trial.
[!includeMicrosoft Defender for Endpoint API URIs for US Government]
[!includeImprove request performance]
Start automated investigation on a device.
See Overview of automated investigations for more information.
- Rate limitations for this API are 50 calls per hour.
Your organization must have Defender for Endpoint (see Minimum requirements for Microsoft Defender for Endpoint.
Currently, AIR only supports the following OS versions:
- Windows Server 2019
- Windows Server 2022
- Windows 10, version 1709 (OS Build 16299.1085 with KB4493441) or later
- Windows 10, version 1803 (OS Build 17134.704 with KB4493464) or later
- Windows 10, version 1803 or later
- Windows 11
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Use Microsoft Defender for Endpoint APIs
Permission type | Permission | Permission display name |
---|---|---|
Application | Alert.ReadWrite.All | 'Read and write all alerts' |
Delegated (work or school account) | Alert.ReadWrite | 'Read and write alerts' |
Note
When obtaining a token using user credentials:
- The user needs to have at least the following role permission: 'Active remediation actions' (See Create and manage roles for more information)
- The user needs to have access to the device, based on device group settings (See Create and manage device groups for more information)
Device group creation is supported in Defender for Endpoint Plan 1 and Plan 2.
POST https://api.security.microsoft.com/api/machines/{id}/startInvestigation
Name | Type | Description |
---|---|---|
Authorization | String | Bearer {token}. Required. |
Content-Type | string | application/json. Required. |
In the request body, supply a JSON object with the following parameters:
Parameter | Type | Description |
---|---|---|
Comment | String | Comment to associate with the action. Required. |
If successful, this method returns 201 - Created response code and Investigation in the response body.
Here is an example of the request.
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/startInvestigation
{
"Comment": "Test investigation"
}