Find devices by tag API

Applies to:

• Microsoft Defender for Endpoint Plan 1
• Microsoft Defender for Endpoint Plan 2

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

Find Machines by Tag.

startswith query is supported.

Limitations

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

Permission type	Permission	Permission display name
Application	Machine.Read.All	'Read all machine profiles'
Application	Machine.ReadWrite.All	'Read and write all machine information'
Delegated (work or school account)	Machine.Read	'Read machine information'
Delegated (work or school account)	Machine.ReadWrite	'Read and write machine information'

Note

When obtaining a token using user credentials:

• Response will include only devices that the user have access to based on device group settings (For more information, see Create and manage device groups)
• The user needs to have at least the following role permission: 'View Data' (For more information, see Create and manage roles)
• Response will include only devices that the user have access to 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.

HTTP request

GET /api/machines/findbytag?tag={tag}&useStartsWithFilter={true/false}

Request headers

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

Request URI parameters

Name	Type	Description
tag	String	The tag name. Required.
useStartsWithFilter	Boolean	When set to true, the search finds all devices with tag name that starts with the given tag in the query. Defaults to false. Optional.

Request body

Empty

Response

If successful - 200 OK with list of the machines in the response body.

Example

Request

Here's an example of the request.

GET https://api.securitycenter.microsoft.com/api/machines/findbytag?tag=testTag&useStartsWithFilter=true

Tip

Do you want to learn more? Engage with the Microsoft Security community in our Tech Community: Microsoft Defender for Endpoint Tech Community.