Collect investigation package API
Applies to:
Want to experience Microsoft Defender for Endpoint? Sign up for a free trial.
Note
If you are a US Government customer, please use the URIs listed in Microsoft Defender for Endpoint for US Government customers.
Tip
For better performance, you can use server closer to your geo location:
- 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 description
Collect investigation package from a device.
Limitations
- Rate limitations for this API are 100 calls per minute and 1500 calls per hour.
Important
- These response actions are only available for devices on Windows 10, version 1703 or later, and on Windows 11.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Use Defender for Endpoint APIs
| Permission type | Permission | Permission display name |
|---|---|---|
| Application | Machine.CollectForensics | 'Collect forensics' |
| Delegated (work or school account) | Machine.CollectForensics | 'Collect forensics' |
Note
When obtaining a token using user credentials:
- The user needs to have at least the following role permission: 'Alerts Investigation' (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.
HTTP request
POST https://api.securitycenter.microsoft.com/api/machines/{id}/collectInvestigationPackage
Request headers
| Name | Type | Description |
|---|---|---|
| Authorization | String | Bearer {token}. Required. |
| Content-Type | string | application/json. Required. |
Request body
In the request body, supply a JSON object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
| Comment | String | Comment to associate with the action. Required. |
Response
If successful, this method returns 201 - Created response code and Machine Action in the response body. If a collection is already running, this returns 400 Bad Request.
Example
Request
Here is an example of the request.
POST https://api.securitycenter.microsoft.com/api/machines/fb9ab6be3965095a09c057be7c90f0a2/collectInvestigationPackage
{
"Comment": "Collect forensics due to alert 1234"
}
Tip
Do you want to learn more? Engage with the Microsoft Security community in our Tech Community: Microsoft Defender for Endpoint Tech Community.