Add or remove a tag for multiple machines

Article
04/30/2024

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

Adds or removes a tag for the specified set of machines.

Limitations

You can post on machines last seen according to your configured retention period.
Rate limitations for this API are 100 calls per minute and 1,500 calls per hour.
We can add or remove a tag for up to 500 machines per API call.

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	Machine.ReadWrite.All	'Read and write all machine information'
Delegated (work or school account)	Machine.ReadWrite	'Read and write machine information'

Note

When obtaining a token using user credentials:

The user needs to have at least the following role permission: 'Manage security setting'. For more information, see Create and manage roles.
The user needs to have access to the machine, based on machine group settings (See Create and manage machine groups for more information).

HTTP request

POST https://api.securitycenter.microsoft.com/api/machines/AddOrRemoveTagForMultipleMachines

Request headers

Name	Type	Description
Authorization	String	Bearer {token}. Required.
Content-Type	string	application/json. Required.

Request body

In the request body, supply a JSON object with the following parameters:

Parameter	Type	Description
Value	String	The tag name. Required.
Action	Enum	Add or Remove. Allowed values are: 'Add' or 'Remove'. Required.
MachineIds	List (String)	List of machine IDs to update. Required.

Response

If successful, this method returns 200 - Ok response code and the updated machines in the response body.

Example Request

Here's an example of a request that adds a tag to multiple machines.

POST https://api.securitycenter.microsoft.com/api/machines/AddOrRemoveTagForMultipleMachines

{
  "Value" : "Tag",
  "Action": "Add",
  "MachineIds": ["34e83ca3feea4dae2353006ba389262c033a025e",
  "2a398439b4975924e87a65943972bc702469b329",
  "a610c00c65fdf79960cc0077d9d8c569d23f09a5"]
}

To remove machine tags, set the Action to 'Remove' instead of 'Add' in the request body.

Tip

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

Share via