Settings API - Automatically applied tags schema table

Automatically applied tags (`builtin:tags.auto-tagging`)

Tags simplify searches for related services, process groups, and hosts. They also facilitate the collection of related metrics into meaningful groups for analysis.

In dynamic or large environments, manual tagging of such entities is often impractical. In such cases, it's recommended that you use automated rule-based tags.

Rule-based tags behave just like manually-applied tags, except they're applied automatically to new entities that match defined rules. Automated rule-based tags can't be removed manually from individual services, process groups, or hosts. Rule-based tags are removed automatically once an entity no longer matches a defined rule.

For value suggestions based on entity data and preview functionality, environment-wide "Access environment" permission is required.

Schema ID	Schema groups	Scope
`builtin:tags.auto-tagging`	`group:tags`	`environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:tags.auto-tagging`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:tags.auto-tagging`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:tags.auto-tagging`

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Property	Label	Type	Description	Required
name	Tag name	text	-	required
description	Description	text	-	optional
rules	Rules	set	-	required

Request body objects

The `AttributeCondition` object

Property	Label	Type	Description	Required
key	Property	enum	-	required
dynamicKeySource	Key source	text	-	required
dynamicKey	Dynamic key	text	-	required
operator	Operator	enum	-	required
enumValue	Value	text	-	required
stringValue	Value	text	-	required
caseSensitive	Case sensitive	boolean	-	required
integerValue	Value	integer	-	required
entityId	Value	text	-	required
tag	Tag	text	Format: `[CONTEXT]tagKey:tagValue`	required

The `AutoTagAttributeRule` object

Property	Label	Type	Description	Required
entityType	Rule applies to	enum	-	required
conditions	Conditions	set	-	required
serviceToHostPropagation	Apply to underlying hosts of matching services	boolean	-	required
serviceToPGPropagation	Apply to underlying process groups of matching services	boolean	-	required
pgToHostPropagation	Apply to underlying hosts of matching process groups	boolean	-	required
pgToServicePropagation	Apply to all services provided by the process groups	boolean	-	required
hostToPGPropagation	Apply to processes running on matching hosts	boolean	-	required
azureToServicePropagation	Apply to services provided by matching Azure entities	boolean	-	required
azureToPGPropagation	Apply to process groups connected to matching Azure entities	boolean	-	required

The `Rule` object

Property	Label	Type	Description	Required
enabled	Enabled	boolean	-	required
valueFormat	Optional tag value	text	Type '{' for placeholder suggestions	optional
valueNormalization	Value Normalization	enum	-	required
type	Rule type	enum	-	required
attributeRule	-	AutoTagAttributeRule	-	required
entitySelector	Entity selector	text	The documentation of the entity selector can be found here.	required

Settings API - Automatically applied tags schema table

Automatically applied tags (builtin:tags.auto-tagging)