Custom tags API - DELETE tags

Deletes the specified custom tag from the specified monitored entities.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

DELETE
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/tags
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/tags

Authentication

To execute this request, you need the Write entities (entities.write) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
key string

The tag to be deleted.

 query required
value string

The tag to be deleted.

 query optional
deleteAllWithKey boolean

The tag to be deleted.

 query optional
entitySelector string

Specifies the entities where you want to delete tags.

You need to set one of these criteria:

  • Entity type: type("value").
  • Dynatrace entity ID: entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")).

And you can add one or several of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified.

  • Tag: tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. If a value-only tag has a colon (:) in it, you must escape the colon with a backslash(\). Otherwise, the tag will be parsed as a key:value tag. All tag values are case-sensitive.
  • Management zone ID: mzId("ID")
  • Management zone name: mzName("value").
  • Dynatrace entity name: entityName("value"). The CONTAINS operator is used and the value is NOT case-sensitive.
  • Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY")

To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in response.

For more information, see the Entity selector help page.

The length of the string is limited to 10,000 characters.

 query required

Response

Response codes

Code Description
200

Success

Response body

The DeletedEntityTags object

Deleted custom tag.

Element Type Description
matchedEntitiesCount integer

The number of monitored entities where the tag has been deleted.

Example

In this example, the request deletes the REST-test custom tag creates in the POST request example. Again the entitySelector query parameter is set to type("HOST"),tag("easyTravel").

The API token is passed in the Authorization header.

Curl

curl -L -X DELETE 'https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22HOST%22),tag(%22easyTravel%22)&tag=REST-test' \
-H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22HOST%22),tag(%22easyTravel%22)&tag=REST-test

Response body

{
  "deletedTag": {
    "context": "CONTEXTLESS",
    "key": "REST-test",
    "stringRepresentation": "REST-test"
  },
  "matchedEntitiesCount": 3
}

Response code

200