• Home
  • Dynatrace API
  • Environment
  • Custom tags
  • POST tags

Custom tags API - POST tags

Add custom tags to the specified monitored entities.

The request consumes and produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/tags
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/tags
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/tags

Authentication

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.

Parameters

ParameterTypeDescriptionInRequired
entitySelectorstring

Specifies the entities where you want to update tags.

You must set one of these criteria:

  • Entity type: type("TYPE")
  • Dynatrace entity ID: 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: 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.
  • Management zone ID: mzId(123)
  • Management zone name: mzName("value")
  • Entity name:
    • 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.
  • Health state (HEALTHY,UNHEALTHY): healthState("HEALTHY")
  • First seen timestamp: 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 time
    • lt: earlier than the specified time
    • gte: later than or at the specified time
    • gt: later than the specified time
  • Entity attribute: <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.
  • Relationships: 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.
  • Negation: 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.

queryrequired
fromstring

The start of the requested timeframe.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 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.
  • Relative timeframe, back from now. The format is 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: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the relative timeframe of 24 hours is used (now-24h).

queryoptional
tostring

The end of the requested timeframe.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 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.
  • Relative timeframe, back from now. The format is 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: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the current timestamp is used.

queryoptional
bodyAddEntityTags

The JSON body of the request. Contains tags to be added to the matching entities.

bodyoptional

Request body objects

The AddEntityTags object

A list of tags to be added to monitored entities.

ElementTypeDescriptionRequired
tagsAddEntityTag[]

A list of tags to be added to monitored entities.

required

The AddEntityTag object

The custom tag to be added to monitored entities.

ElementTypeDescriptionRequired
valuestring

The value of the custom tag to be added to monitored entities. May be null

optional
keystring

The key of the custom tag to be added to monitored entities.

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "tags": [ { "key": "mainApp" }, { "key": "bookings", "value": "42" } ] }

Response

Response codes

CodeTypeDescription
200AddedEntityTags

Success

Response body objects

The AddedEntityTags object

A list of custom tags added to monitored entities.

ElementTypeDescription
matchedEntitiesCountinteger

The number of monitored entities where the tags have been added.

appliedTagsMETag[]

A list of added custom tags.

The METag object

The tag of a monitored entity.

ElementTypeDescription
stringRepresentationstring

The string representation of the tag.

valuestring

The value of the tag.

keystring

The key of the tag.

contextstring

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

Response body JSON model

json
{ "appliedTags": [ { "context": "CONTEXTLESS", "key": "mainApp", "stringRepresentation": "mainApp" }, { "context": "CONTEXTLESS", "key": "booking", "stringRepresentation": "booking" } ], "matchedEntitiesCount": 2 }

Example

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

bash
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" } ] }'

Request URL

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

Request body

json
{ "tags": [ { "key": "REST-test" }, { "key": "RESTexample" } ] }

Response body

json
{ "matchedEntitiesCount": 3, "appliedTags": [ { "context": "CONTEXTLESS", "key": "REST-test", "stringRepresentation": "REST-test" }, { "context": "CONTEXTLESS", "key": "RESTexample", "stringRepresentation": "RESTexample" } ] }

Response code

200

Related topics
  • Monitored entities API v2

    Learn about the Dynatrace Entity API v2.