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.
Tagging rules are executed periodically in the background, for a limited timeframe. Any entity that matches a tagging rule will receive the specific tag, while removing tags from entities that no longer match. Be aware that for any condition that requires the relationship between multiple entities, all entities in this scope need to be present in this timeframe!
Depending on environment-size, rule count (tagging rules, as well as management zone and naming rules) and rule complexity, the application of all tags might be delayed! For faster, unchanging tagging, please utilize the tagging REST API!
Schema ID | Schema groups | Scope |
---|---|---|
builtin:tags.auto-tagging |
| environment |
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 | Type | Description | Required |
---|---|---|---|
Tag namename | text | - | required |
Descriptiondescription | text | - | optional |
Rulesrules | Set<Rule> | - | required |
The Rule
object
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | - | required |
Optional tag valuevalueFormat | text | Type '{' for placeholder suggestions | optional |
Value NormalizationvalueNormalization | enum |
| required |
Rule typetype | enum |
| required |
attributeRule | AutoTagAttributeRule | - | required |
Entity selectorentitySelector | text | The documentation of the entity selector can be found here. | required |
The AutoTagAttributeRule
object
Property | Type | Description | Required |
---|---|---|---|
Rule applies toentityType | enum |
| required |
Conditionsconditions | Set<AttributeCondition> | - | required |
Apply to underlying hosts of matching servicesserviceToHostPropagation | boolean | - | required |
Apply to underlying process groups of matching servicesserviceToPGPropagation | boolean | - | required |
Apply to underlying hosts of matching process groupspgToHostPropagation | boolean | - | required |
Apply to all services provided by the process groupspgToServicePropagation | boolean | - | required |
Apply to processes running on matching hostshostToPGPropagation | boolean | - | required |
Apply to services provided by matching Azure entitiesazureToServicePropagation | boolean | - | required |
Apply to process groups connected to matching Azure entitiesazureToPGPropagation | boolean | - | required |
The AttributeCondition
object
Property | Type | Description | Required |
---|---|---|---|
Propertykey | enum |
| required |
Key sourcedynamicKeySource | text | - | required |
Dynamic keydynamicKey | text | - | required |
Operatoroperator | enum |
| required |
ValueenumValue | text | - | required |
ValuestringValue | text | - | required |
Case sensitivecaseSensitive | boolean | - | required |
ValueintegerValue | integer | - | required |
ValueentityId | text | - | required |
Tagtag | text | Format: | required |