Collect investigation package API

API description

Collect investigation package from a device.

Limitations

• Rate limitations for this API are 100 calls per minute and 1500 calls per hour.

Permissions

When obtaining a token using user credentials:

• The user needs to have at least the following role permission: 'Alerts Investigation'. For more information, see: Create and manage roles
• The user needs to have access to the device, based on device group settings. For more information, see: Create and manage device groups

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'

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"
}