Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.04 KB

get-ip-related-alerts.md

File metadata and controls

93 lines (67 loc) · 3.04 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
Get IP related alerts API
Retrieve a collection of alerts related to a given IP address using Microsoft Defender for Endpoint.
defender-endpoint
siosulli
siosulli
medium
deniseb
ITPro
m365-security
tier3
must-keep
reference
reference
api
met150
12/18/2020

Get IP related alerts API

[!INCLUDE Microsoft Defender XDR rebranding]

Applies to:

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

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

[!includeImprove request performance]

API description

Retrieves a collection of alerts related to a given IP address.

Limitations

  1. Rate limitations for this API are 100 calls per minute and 1,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 Defender for Endpoint APIs.

Permission type Permission Permission display name
Application Alert.Read.All Read all alerts
Application Alert.ReadWrite.All Read and write all alerts
Delegated (work or school account) Alert.Read Read 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: View Data. For more information, see Create and manage roles for more information.
  • Response includes only alerts, associated with devices, that the user have access to, based on device group settings (See Create and manage device groups for more information)

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

HTTP request

GET /api/ips/{ip}/alerts

Request headers

Name Type Description
Authorization String Bearer {token}. Required.

Request body

Empty

Response

If successful and IP exists - 200 OK with list of alert entities in the body. If IP address is unknown but valid, it returns an empty set. If the IP address is invalid, it returns HTTP 400.

Example

Request

Here's an example of the request.

GET https://api.securitycenter.microsoft.com/api/ips/10.209.67.177/alerts

[!INCLUDE Microsoft Defender for Endpoint Tech Community]