title | description | ms.service | ms.author | author | ms.localizationpriority | manager | audience | ms.collection | ms.topic | ms.subservice | ms.custom | search.appverid | ms.date | |||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get alert-related IPs' information |
Retrieve all IPs related to a specific alert using Microsoft Defender for Endpoint. |
defender-endpoint |
siosulli |
siosulli |
medium |
deniseb |
ITPro |
|
reference |
reference |
api |
met150 |
12/18/2020 |
[!INCLUDE Microsoft Defender XDR rebranding]
Applies to:
- Microsoft Defender for Endpoint Plan 1
- Microsoft Defender for Endpoint Plan 2
- Microsoft Defender XDR
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]
Retrieves all IPs related to a specific alert.
- You can query on alerts last updated according to your configured retention period.
- Rate limitations for this API are 100 calls per minute and 1500 calls per hour.
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 | Ip.Read.All | 'Read IP address profiles' |
Delegated (work or school account) | Ip.Read.All | 'Read IP address profiles' |
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
- 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.
GET /api/alerts/{id}/ips
Name | Type | Description |
---|---|---|
Authorization | String | Bearer {token}. Required. |
Empty
If successful and alert and an IP exist - 200 OK. If alert not found - 404 Not Found.
Here's an example of the request.
GET https://api.securitycenter.microsoft.com/alerts/636688558380765161_2136280442/ips
Here's an example of the response.
{
"@odata.context": "https://api.securitycenter.microsoft.com/$metadata#Ips",
"value": [
{
"id": "104.80.104.128"
},
{
"id": "23.203.232.228
}
...
]
}