Add custom tags to the specified monitored entities.
The request consumes and produces an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/tags |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/tags |
To execute this request, you need an access token with entities.write scope.
To learn how to obtain and use it, see Tokens and authentication.
Specifies the entities where you want to update tags.
You must set one of these criteria:
type("TYPE")entityId("id"). You can specify several IDs, separated by a comma (entityId("id-1","id-2")). All requested entities must be of the same type.You can add one or more of the following criteria. Values are case-sensitive and the EQUALS operator is used unless otherwise specified.
tag("value"). Tags in [context]key:value, key:value, and value formats are detected and parsed automatically. Any colons (:) that are part of the key or value must be escaped with a backslash(\). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.mzId(123)mzName("value")entityName.equals: performs a non-casesensitive EQUALS query.entityName.startsWith: changes the operator to BEGINS WITH.entityName.in: enables you to provide multiple values. The EQUALS operator applies.caseSensitive(entityName.equals("value")): takes any entity name criterion as an argument and makes the value case-sensitive.healthState("HEALTHY")firstSeenTms.<operator>(now-3h). Use any timestamp format from the from/to parameters.
The following operators are available:
lte: earlier than or at the specified timelt: earlier than the specified timegte: later than or at the specified timegt: later than the specified time<attribute>("value1","value2") and <attribute>.exists(). To fetch the list of available attributes, execute the GET entity type request and check the properties field of the response.fromRelationships.<relationshipName>() and toRelationships.<relationshipName>(). This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the GET entity type request and check the fromRelationships and toRelationships fields.not(<criterion>). Inverts any criterion except for type.For more information, see Entity selector in Dynatrace Documentation.
To set several criteria, separate them with a comma (,). For example, type("HOST"),healthState("HEALTHY"). Only results matching all criteria are included in the response.
The maximum string length is 2,000 characters.
The start of the requested timeframe.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week.
You can also specify relative timeframe without an alignment: now-NU.
Supported time units for the relative timeframe are:
m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the relative timeframe of 24 hours is used (now-24h).
The end of the requested timeframe.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week.
You can also specify relative timeframe without an alignment: now-NU.
Supported time units for the relative timeframe are:
m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the current timestamp is used.
The JSON body of the request. Contains tags to be added to the matching entities.
AddEntityTags objectA list of tags to be added to monitored entities.
AddEntityTag objectThe custom tag to be added to monitored entities.
The key of the custom tag to be added to monitored entities.
The value of the custom tag to be added to monitored entities. May be null
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"tags": [{"key": "mainApp"},{"key": "bookings","value": "42"}]}
AddedEntityTags objectA list of custom tags added to monitored entities.
The number of monitored entities where the tags have been added.
METag objectThe tag of a monitored entity.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS value.
The key of the tag.
The string representation of the tag.
The value of the tag.
{"appliedTags": [{"context": "CONTEXTLESS","key": "mainApp","stringRepresentation": "mainApp"},{"context": "CONTEXTLESS","key": "booking","stringRepresentation": "booking"}],"matchedEntitiesCount": 2}
In this example, the request adds the REST-test and RESTexample custom tags to hosts that already have the easyTravel tag. To achieve that, the entitySelector query parameter is set to type("HOST"),tag("easyTravel").
The API token is passed in the Authorization header.
curl -L -X POST 'https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22HOST%22),tag(%22easyTravel%22)' \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \-H 'Content-Type: application/json' \--data-raw '{"tags": [{"key": "REST-test"},{"key": "RESTexample"}]}'
https://mySampleEnv.live.dynatrace.com/api/v2/tags?entitySelector=type(%22HOST%22),tag(%22easyTravel%22)
{"tags": [{"key": "REST-test"},{"key": "RESTexample"}]}
{"matchedEntitiesCount": 3,"appliedTags": [{"context": "CONTEXTLESS","key": "REST-test","stringRepresentation": "REST-test"},{"context": "CONTEXTLESS","key": "RESTexample","stringRepresentation": "RESTexample"}]}
200