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:
- api-us.securitycenter.microsoft.com
- api-eu.securitycenter.microsoft.com
- api-uk.securitycenter.microsoft.com
API description
Updates properties of a batch of existing Alerts.
Submission of comment is available with or without updating properties.
Updatable properties are: status
, determination
, classification
and assignedTo
.
Limitations
- You can update alerts that are available in the API. See List Alerts for more information.
- Rate limitations for this API are 10 calls per minute and 500 calls per hour.
Permissions
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: ‘Alerts investigation’ (See Create and manage roles for more information)
- The user needs to have access to the device associated with the alert, based on device group settings (See Create and manage device groups for more information)
HTTP request
POST /api/alerts/batchUpdate
Request headers
Name | Type | Description |
---|---|---|
Authorization | String | Bearer {token}. Required. |
Content-Type | String | application/json. Required. |
Request body
In the request body, supply the IDs of the alerts to be updated and the values of the relevant fields that you wish to update for these alerts.
Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values.
For best performance you shouldn’t include existing values that haven’t changed.
Property | Type | Description |
---|---|---|
alertIds | List<String> | A list of the IDs of the alerts to be updated. Required |
status | String | Specifies the updated status of the specified alerts. The property values are: ‘New’, ‘InProgress’ and ‘Resolved’. |
assignedTo | String | Owner of the specified alerts |
classification | String | Specifies the specification of the specified alerts. The property values are: ‘Unknown’, ‘FalsePositive’, ‘TruePositive’. |
determination | String | Specifies the determination of the specified alerts. The property values are: ‘NotAvailable’, ‘Apt’, ‘Malware’, ‘SecurityPersonnel’, ‘SecurityTesting’, ‘UnwantedSoftware’, ‘Other’ |
comment | String | Comment to be added to the specified alerts. |
Response
If successful, this method returns 200 OK, with an empty response body.
Example
Request
Here is an example of the request.
POST https://api.securitycenter.microsoft.com/api/alerts/batchUpdate
{
"alertIds": ["da637399794050273582_760707377", "da637399989469816469_51697947354"],
"status": "Resolved",
"assignedTo": "[email protected]",
"classification": "FalsePositive",
"determination": "Malware",
"comment": "Resolve my alert and assign to secop2"
}