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 existing Alert.
Submission of comment is available with or without updating properties.
Updatable properties are: status
, determination
, classification
, and assignedTo
.
Limitations
- You can update alerts that available in the API. For more information, see List Alerts.
- Rate limitations for this API are 100 calls per minute and 1500 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 | Alerts.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’ (For more information, see Create and manage roles )
- The user needs to have access to the device associated with the alert, based on device group settings (For more information, see Create and manage device groups
HTTP request
PATCH /api/alerts/{id}
Request headers
Name | Type | Description |
---|---|---|
Authorization | String | Bearer {token}. Required. |
Content-Type | String | application/json. Required. |
Request body
In the request body, supply the values for the relevant fields that should be updated.
Existing properties that aren’t 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 change.
Property | Type | Description |
---|---|---|
Status | String | Specifies the current status of the alert. The property values are: ‘New’, ‘InProgress’ and ‘Resolved’. |
assignedTo | String | Owner of the alert |
Classification | String | Specifies the specification of the alert. The property values are: ‘Unknown’, ‘FalsePositive’, ‘TruePositive’. |
Determination | String | Specifies the determination of the alert. The property values are: ‘NotAvailable’, ‘Apt’, ‘Malware’, ‘SecurityPersonnel’, ‘SecurityTesting’, ‘UnwantedSoftware’, ‘Other’ |
Comment | String | Comment to be added to the alert. |
Response
If successful, this method returns 200 OK, and the alert entity in the response body with the updated properties. If alert with the specified ID wasn’t found – 404 Not Found.
Example
Request
Here’s an example of the request.
PATCH https://api.securitycenter.microsoft.com/api/alerts/121688558380765161_2136280442
{
"status": "Resolved",
"assignedTo": "[email protected]",
"classification": "FalsePositive",
"determination": "Malware",
"comment": "Resolve my alert and assign to secop2"
}