Skip to content

Latest commit

 

History

History
120 lines (88 loc) · 5.23 KB

update-alert.md

File metadata and controls

120 lines (88 loc) · 5.23 KB
Raw
title description ms.service ms.author author ms.localizationpriority manager audience ms.collection ms.topic ms.subservice ms.custom search.appverid ms.date
Update alert entity API
Learn how to update a Microsoft Defender for Endpoint alert by using this API. You can update the status, determination, classification, and assignedTo properties.
defender-endpoint
siosulli
siosulli
medium
deniseb
ITPro
m365-security
tier3
must-keep
reference
reference
api
met150
11/17/2023

Update alert

[!INCLUDE Microsoft Defender XDR rebranding]

Applies to:

Want to experience Microsoft Defender for Endpoint? Sign up for a free trial.

[!IncludeMicrosoft Defender for Endpoint API URIs for US Government]

[!IncludeImprove request performance]

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

  1. You can update alerts that available in the API. For more information, see List Alerts.
  2. 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

Device group creation is supported in Defender for Endpoint Plan 1 and Plan 2.

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: TruePositive, InformationalExpectedActivity, and FalsePositive.
Determination String Specifies the determination of the alert.

Possible determination values for each classification are:

  • True positive: Multistage attack (MultiStagedAttack), Malicious user activity (MaliciousUserActivity), Compromised account (CompromisedUser) – consider changing the enum name in public api accordingly, Malware (Malware), Phishing (Phishing), Unwanted software (UnwantedSoftware), and Other (Other).
  • Informational, expected activity: Security test (SecurityTesting), Line-of-business application (LineOfBusinessApplication), Confirmed activity (ConfirmedActivity) - consider changing the enum name in public api accordingly, and Other (Other).
  • False positive: Not malicious (NotMalicious) - consider changing the enum name in public api accordingly, Not enough data to validate (InsufficientData), and Other (Other).
    		•
    Comment String Comment to be added to the alert.

    Note

    Around August 29, 2022, previously supported alert determination values ('Apt' and 'SecurityPersonnel') will be deprecated and no longer available via the API.

    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": "secop2@contoso.com",
    "classification": "FalsePositive",
    "determination": "Malware",
    "comment": "Resolve my alert and assign to secop2"
}

    [!INCLUDE Microsoft Defender for Endpoint Tech Community]