List all recommendations
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.
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:
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
Important
Some information in this article relates to a prereleased product which may be substantially modified before it's commercially released. Microsoft makes no warranties, expressed or implied, with respect to the information provided here.
Retrieves a list of all security recommendations affecting the organization.
API description
Returns information about all security recommendations affecting the organization.
URL: GET:/api/recommendations
Supports OData V4 queries.
OData supported operators:
$filter
on: id
, productName
, vendor
, recommendedVersion
, recommendationCategory
, subCategory
, severityScore
, remediationType
, recommendedProgram
, recommendedVendor
, and status
properties.
$top
with max value of 10,000.
$skip
.
See examples at OData queries with Microsoft Defender for Endpoint.
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 for details.
Permission type | Permission | Permission display name |
---|---|---|
Application | SecurityRecommendation.Read.All | 'Read Threat and Vulnerability Management security recommendation information' |
Delegated (work or school account) | SecurityRecommendation.Read | 'Read Threat and Vulnerability Management security recommendation information' |
HTTP request
GET /api/recommendations
Request headers
Name | Type | Description |
---|---|---|
Authorization | String | Bearer {token}. Required. |
Request body
Empty
Response
If successful, this method returns 200 OK with the list of security recommendations in the body.
Example
Request
Here is an example of the request.
GET https://api.securitycenter.microsoft.com/api/recommendations
Response
Here is an example of the response.
{
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Recommendations",
"value": [
{
"id": "va-_-microsoft-_-edge_chromium-based",
"productName": "edge_chromium-based",
"recommendationName": "Update Microsoft Edge Chromium-based to version 127.0.2651.74",
"weaknesses": 762,
"vendor": "microsoft",
"recommendedVersion": "127.0.2651.74",
"recommendedVendor": "",
"recommendedProgram": "",
"recommendationCategory": "Application",
"subCategory": "",
"severityScore": 0,
"publicExploit": true,
"activeAlert": false,
"associatedThreats": [
"71d9120e-7eea-4058-889a-1a60bbf7e312"
],
"remediationType": "Update",
"status": "Active",
"configScoreImpact": 0,
"exposureImpact": 1.1744086343876479,
"totalMachineCount": 261,
"exposedMachinesCount": 193,
"nonProductivityImpactedAssets": 0,
"relatedComponent": "Edge Chromium-based",
"hasUnpatchableCve": false,
"tags": [
"internetFacing"
],
"exposedCriticalDevices": 116
}
]
}
See also
Tip
Do you want to learn more? Engage with the Microsoft Security community in our Tech Community: Microsoft Defender for Endpoint Tech Community.