Custom tags API - DELETE tags
Deletes the specified custom tag from the specified monitored entities.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
DELETE |
|
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:
And you can add one or several of the following criteria. Values are case-sensitive and the
To set several criteria, separate them with a comma ( 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. |
{
"matchedEntitiesCount": 2
}
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