Edit

Share via

Add or remove a tag for a machine

  • Article

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 a specific device.

Note

If you are looking for how to tag machines in bulk via API, see Add or remove multiple machine tags.

Limitations

  1. You can post on machines last seen according to your configured retention period.

  2. 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 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 (See Create and manage roles for more information).
  • 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/{id}/tags

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.

Response

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

Example Request

Here is an example of a request that adds a machine tag.

POST https://api.securitycenter.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/tags

{
  "Value" : "test Tag 2",
  "Action": "Add"
}

To remove machine tag, 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.