Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 5.34 KB

api-incident.md

File metadata and controls

92 lines (69 loc) · 5.34 KB
Raw
title description ms.service f1.keywords ms.author author ms.localizationpriority manager audience ms.collection ms.topic search.appverid ms.custom ms.date
Microsoft Defender XDR incidents APIs and the incidents resource type
Learn about the methods and properties of the Incidents resource type in Microsoft Defender XDR.
defender-xdr
NOCSH
macapara
mjcaparas
medium
dansimp
ITPro
m365-security
tier3
must-keep
reference
MOE150
MET150
api
07/30/2024

Microsoft Defender XDR incidents API and the incidents resource type

[!INCLUDE Microsoft Defender XDR rebranding]

Applies to:

Note

Try our new APIs using MS Graph security API. Find out more at: Use the Microsoft Graph security API - Microsoft Graph | Microsoft Learn.

Important

Some information relates to prereleased product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An incident is a collection of related alerts that help describe an attack. Events from different entities in your organization are aggregated automatically by Microsoft Defender XDR. You can use the incidents API to programmatically access your organization's incidents and related alerts.

Quotas and resource allocation

You can request up to 50 calls per minute or 1,500 calls per hour. Each method also has its own quotas. For more information on method-specific quotas, see the respective article for the method you want to use.

A 429 HTTP response code indicates that you've reached a quota, either by number of requests sent, or by allotted running time. The response body includes the time until the quota you reached is reset.

Permissions

The incidents API requires different kinds of permissions for each of its methods. For more information about required permissions, see the respective method's article.

Methods

Method Return Type Description
List incidents Incident list Get a list of incidents.
Update incident Incident Update a specific incident.
Get incident Incident Get a single incident.

Request body, response, and examples

Refer to the respective method articles for more details on how to construct a request or parse a response, and for practical examples.

Common properties

Property Type Description
incidentId long Incident unique ID.
redirectIncidentId nullable long The Incident ID the current Incident was merged to.
incidentName string The name of the Incident.
createdTime DateTimeOffset The date and time (in UTC) the Incident was created.
lastUpdateTime DateTimeOffset The date and time (in UTC) the Incident was last updated.
assignedTo string Owner of the Incident.
severity Enum Severity of the Incident. Possible values are: UnSpecified, Informational, Low, Medium, and High.
status Enum Specifies the current status of the incident. Possible values are: Active, InProgress, Resolved, and Redirected.
classification Enum Specification of the incident. Possible values are: TruePositive, Informational, expected activity, and FalsePositive.
determination Enum Specifies the determination of the incident.

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 (ConfirmedUserActivity) - consider changing the enum name in public api accordingly, and Other (Other).
  • False positive: Not malicious (Clean) - consider changing the enum name in public api accordingly, Not enough data to validate (InsufficientData), and Other (Other).
    		•
    tags string list List of Incident tags (customTags only).
    comments List of incident comments Incident Comment object contains: comment string, createdBy string, and createTime date time.
    alerts alert list List of related alerts. See examples at List incidents API documentation.

    Note

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

    Related articles

    [!INCLUDE Microsoft Defender XDR rebranding]