List software inventory API
Applies to:
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
API description
Retrieves the organization software inventory.
Supports OData V4 queries.
OData supported operators:
$filter
on: id
, name
, and vendor
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 | Software.Read.All | 'Read Threat and Vulnerability Management Software information' |
Delegated (work or school account) | Software.Read | 'Read Threat and Vulnerability Management Software information' |
HTTP request
GET /api/Software
Request headers
Name | Type | Description |
---|---|---|
Authorization | String | Bearer {token}. Required. |
Request body
Empty
Response
If successful, this method returns 200 OK with the software inventory in the body.
Example
Request example
Here is an example of the request.
GET https://api.security.microsoft.com/api/Software
Response example
Here is an example of the response.
{
"@odata.context": "https://api.security.microsoft.com/api/$metadata#Software",
"value": [
{
"id": "microsoft-_-edge",
"name": "edge",
"vendor": "microsoft",
"weaknesses": 467,
"publicExploit": true,
"activeAlert": false,
"exposedMachines": 172,
"impactScore": 2.39947438
}
...
]
}
Related topics
Tip
Do you want to learn more? Engage with the Microsoft Security community in our Tech Community: Microsoft Defender for Endpoint Tech Community.