Automatically applied tags API - POST an auto tag

Creates a new automatically applied tag.

The request consumes and produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/autoTags

Parameters

Refer to JSON models to find all JSON models that depend on the type of the model.

Parameter Type Description In Required
body AutoTag

JSON body of the request, containing parameters of the new auto tag.

body optional

The AutoTag object

Configuration for an auto tag. It defines the tag value and conditions of its usage.

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
id string

The ID of the auto tag.

optional
name string

The name of the auto tag, which is applied to entities.

If a valueFormat is specified, the tag is presented in the key:value format, where key is the tag's name. In that case the format of the tag is name:valueFormat.

required
rules AutoTagRule[]

The list of rules for tag usage.

Each rule is evaluated independently of all other rules.

optional

The AutoTagRule object

An auto tag rule defines the conditions of the tag usage. Each rule is evaluated independently of all other rules.

Element Type Description Required
type string

Type of entities to which the auto tag applies.

The type element can hold these values.
required
enabled boolean

Tag rule enabled/disabled.

required
valueFormat string

Format of the tag value. If specified, the tag is presented in the key:value format, where key is the tag's name. In that case the format of the tag is name:valueFormat.

optional
propagationTypes string[]

How to apply tag to underlying entities:

SERVICE_TO_PROCESS_GROUP_LIKE: Apply to underlying process groups of matching services. SERVICE_TO_HOST_LIKE: Apply to underlying hosts of matching services.

PROCESS_GROUP_TO_HOST: Apply to underlying hosts of matching process groups. PROCESS_GROUP_TO_SERVICE: Apply to all services provided by the process groups.

HOST_TO_PROCESS_GROUP_INSTANCE: Apply to processes running on matching hosts.

optional
conditions EntityRuleEngineCondition[]

Matching rules of the auto tag. The tag applies only if all conditions are fulfilled.

required

The EntityRuleEngineCondition object

A condition defines how to execute matching logic for an entity.

Element Type Description Required
key ConditionKey

Type-specific key to identify which data we're matching.

required
comparisonInfo ComparisonBasic

Defines how the matching is actually performed: what and how are we comparing.

required

The ComparisonBasic object

Defines how the matching is actually performed: what and how are we comparing. The actual set of fields depends on the type of the comparison.

Element Type Description Required
operator Enum

Operator of the comparision. You can reverse it by setting negate to true.

required
value object

Holds the value to compare to.

optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

required
type string

Defines the actual set of fields depending on the value:

STRING -> StringComparison INTEGER -> IntegerComparison SERVICE_TYPE -> ServiceTypeComparison PAAS_TYPE -> PaasTypeComparison CLOUD_TYPE -> CloudTypeComparision AZURE_SKU -> AzureSkuComparision AZURE_COMPUTE_MODE -> AzureComputeModeComparision ENTITY_ID -> EntityIdComparision SIMPLE_TECH -> SimpleTechComparison SIMPLE_HOST_TECH -> SimpleHostTechComparison SERVICE_TOPOLOGY -> ServiceTopologyComparison DATABASE_TOPOLOGY -> DatabaseTopologyComparision OS_TYPE -> OsTypeComparison HYPERVISOR_TYPE -> HypervisorTypeComparision IP_ADDRESS -> IpAddressComparison OS_ARCHITECTURE -> OsArchitectureComparison BITNESS -> BitnessComparision APPLICATION_TYPE -> ApplicationTypeComparison MOBILE_PLATFORM -> MobilePlatformComparison CUSTOM_APPLICATION_TYPE -> CustomApplicationTypeComparision DCRUM_DECODER_TYPE -> DcrumDecoderComparision SYNTHETIC_ENGINE_TYPE -> SyntheticEngineTypeComparison TAG -> TagComparison

The type element can hold these values.
required

The Enum object

The ConditionKey object

Type-specific key to identify the data for which we want to match against.

This is the base version of the key, depending on the type, the actual JSON may contain additional fields. Check one of the following objects to view them:

  • HOST_CUSTOM_METADATA_KEY -> CustomHostMetadataConditionKey
  • PROCESS_CUSTOM_METADATA_KEY -> CustomProcessMetadataConditionKey
  • PROCESS_PREDEFINED_METADATA_KEY -> ProcessMetadataConditionKey
  • STRING -> StringConditionKey
  • no type -> StaticConditionKey
Element Type Description Required
attribute string

The attribute to use for comparision.

The attribute element can hold these values.
required
type string optional

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional
clusterVersion string

Dynatrace server version.

optional

Possible values

Possible values for the type element in the ComparisonBasic object:

  • STRING
  • INTEGER
  • SERVICE_TYPE
  • PAAS_TYPE
  • CLOUD_TYPE
  • AZURE_SKU
  • AZURE_COMPUTE_MODE
  • ENTITY_ID
  • SIMPLE_TECH
  • SIMPLE_HOST_TECH
  • SERVICE_TOPOLOGY
  • DATABASE_TOPOLOGY
  • OS_TYPE
  • HYPERVISOR_TYPE
  • IP_ADDRESS
  • OS_ARCHITECTURE
  • BITNESS
  • APPLICATION_TYPE
  • MOBILE_PLATFORM
  • CUSTOM_APPLICATION_TYPE
  • DCRUM_DECODER_TYPE
  • SYNTHETIC_ENGINE_TYPE
  • TAG

Possible values for the attribute element in the ConditionKey object:

  • APPMON_SERVER_NAME
  • APPMON_SYSTEM_PROFILE_NAME
  • AWS_ACCOUNT_ID
  • AWS_ACCOUNT_NAME
  • AWS_APPLICATION_LOAD_BALANCER_NAME
  • AWS_APPLICATION_LOAD_BALANCER_TAGS
  • AWS_AUTO_SCALING_GROUP_NAME
  • AWS_AUTO_SCALING_GROUP_TAGS
  • AWS_AVAILABILITY_ZONE_NAME
  • AWS_CLASSIC_LOAD_BALANCER_BACKEND_PORTS
  • AWS_CLASSIC_LOAD_BALANCER_FRONTEND_PORTS
  • AWS_CLASSIC_LOAD_BALANCER_NAME
  • AWS_CLASSIC_LOAD_BALANCER_TAGS
  • AWS_NETWORK_LOAD_BALANCER_NAME
  • AWS_NETWORK_LOAD_BALANCER_TAGS
  • AWS_RELATIONAL_DATABASE_SERVICE_DB_NAME
  • AWS_RELATIONAL_DATABASE_SERVICE_ENDPOINT
  • AWS_RELATIONAL_DATABASE_SERVICE_ENGINE
  • AWS_RELATIONAL_DATABASE_SERVICE_INSTANCE_CLASS
  • AWS_RELATIONAL_DATABASE_SERVICE_NAME
  • AWS_RELATIONAL_DATABASE_SERVICE_PORT
  • AWS_RELATIONAL_DATABASE_SERVICE_TAGS
  • AZURE_REGION_NAME
  • AZURE_SCALE_SET_NAME
  • AZURE_VM_NAME
  • BROWSER_MONITOR_NAME
  • BROWSER_MONITOR_TAGS
  • CLOUD_FOUNDRY_FOUNDATION_NAME
  • CLOUD_FOUNDRY_ORG_NAME
  • CUSTOM_APPLICATION_NAME
  • CUSTOM_APPLICATION_PLATFORM
  • CUSTOM_APPLICATION_TAGS
  • CUSTOM_APPLICATION_TYPE
  • CUSTOM_DEVICE_DETECTED_NAME
  • CUSTOM_DEVICE_DNS_ADDRESS
  • CUSTOM_DEVICE_GROUP_NAME
  • CUSTOM_DEVICE_GROUP_TAGS
  • CUSTOM_DEVICE_IP_ADDRESS
  • CUSTOM_DEVICE_METADATA
  • CUSTOM_DEVICE_NAME
  • CUSTOM_DEVICE_PORT
  • CUSTOM_DEVICE_TAGS
  • CUSTOM_DEVICE_TECHNOLOGY
  • DATA_CENTER_SERVICE_DECODER_TYPE
  • DATA_CENTER_SERVICE_IP_ADDRESS
  • DATA_CENTER_SERVICE_METADATA
  • DATA_CENTER_SERVICE_NAME
  • DATA_CENTER_SERVICE_PORT
  • DATA_CENTER_SERVICE_TAGS
  • DOCKER_CONTAINER_NAME
  • DOCKER_FULL_IMAGE_NAME
  • DOCKER_IMAGE_VERSION
  • DOCKER_STRIPPED_IMAGE_NAME
  • EC2_INSTANCE_AMI_ID
  • EC2_INSTANCE_AWS_INSTANCE_TYPE
  • EC2_INSTANCE_AWS_SECURITY_GROUP
  • EC2_INSTANCE_BEANSTALK_ENV_NAME
  • EC2_INSTANCE_ID
  • EC2_INSTANCE_NAME
  • EC2_INSTANCE_PRIVATE_HOST_NAME
  • EC2_INSTANCE_PUBLIC_HOST_NAME
  • EC2_INSTANCE_TAGS
  • ENTERPRISE_APPLICATION_DECODER_TYPE
  • ENTERPRISE_APPLICATION_IP_ADDRESS
  • ENTERPRISE_APPLICATION_METADATA
  • ENTERPRISE_APPLICATION_NAME
  • ENTERPRISE_APPLICATION_PORT
  • ENTERPRISE_APPLICATION_TAGS
  • ESXI_HOST_CLUSTER_NAME
  • ESXI_HOST_HARDWARE_MODEL
  • ESXI_HOST_HARDWARE_VENDOR
  • ESXI_HOST_NAME
  • ESXI_HOST_PRODUCT_NAME
  • ESXI_HOST_PRODUCT_VERSION
  • ESXI_HOST_TAGS
  • EXTERNAL_MONITOR_ENGINE_DESCRIPTION
  • EXTERNAL_MONITOR_ENGINE_NAME
  • EXTERNAL_MONITOR_ENGINE_TYPE
  • EXTERNAL_MONITOR_NAME
  • EXTERNAL_MONITOR_TAGS
  • GEOLOCATION_SITE_NAME
  • GOOGLE_CLOUD_PLATFORM_ZONE_NAME
  • GOOGLE_COMPUTE_INSTANCE_ID
  • GOOGLE_COMPUTE_INSTANCE_MACHINE_TYPE
  • GOOGLE_COMPUTE_INSTANCE_NAME
  • GOOGLE_COMPUTE_INSTANCE_PROJECT
  • GOOGLE_COMPUTE_INSTANCE_PROJECT_ID
  • GOOGLE_COMPUTE_INSTANCE_PUBLIC_IP_ADDRESSES
  • HOST_AIX_LOGICAL_CPU_COUNT
  • HOST_AIX_SIMULTANEOUS_THREADS
  • HOST_AIX_VIRTUAL_CPU_COUNT
  • HOST_ARCHITECTURE
  • HOST_AWS_NAME_TAG
  • HOST_AZURE_COMPUTE_MODE
  • HOST_AZURE_SKU
  • HOST_AZURE_WEB_APPLICATION_HOST_NAMES
  • HOST_AZURE_WEB_APPLICATION_SITE_NAMES
  • HOST_BITNESS
  • HOST_BOSH_AVAILABILITY_ZONE
  • HOST_BOSH_DEPLOYMENT_ID
  • HOST_BOSH_INSTANCE_ID
  • HOST_BOSH_INSTANCE_NAME
  • HOST_BOSH_NAME
  • HOST_BOSH_STEMCELL_VERSION
  • HOST_CLOUD_TYPE
  • HOST_CUSTOM_METADATA
  • HOST_DETECTED_NAME
  • HOST_GROUP_ID
  • HOST_GROUP_NAME
  • HOST_HYPERVISOR_TYPE
  • HOST_IP_ADDRESS
  • HOST_KUBERNETES_LABELS
  • HOST_NAME
  • HOST_ONEAGENT_CUSTOM_HOST_NAME
  • HOST_OS_TYPE
  • HOST_OS_VERSION
  • HOST_PAAS_MEMORY_LIMIT
  • HOST_PAAS_TYPE
  • HOST_TAGS
  • HOST_TECHNOLOGY
  • HTTP_MONITOR_NAME
  • HTTP_MONITOR_TAGS
  • KUBERNETES_CLUSTER_NAME
  • KUBERNETES_NODE_NAME
  • MOBILE_APPLICATION_NAME
  • MOBILE_APPLICATION_PLATFORM
  • MOBILE_APPLICATION_TAGS
  • NAME_OF_COMPUTE_NODE
  • OPENSTACK_ACCOUNT_NAME
  • OPENSTACK_ACCOUNT_PROJECT_NAME
  • OPENSTACK_AVAILABILITY_ZONE_NAME
  • OPENSTACK_PROJECT_NAME
  • OPENSTACK_REGION_NAME
  • OPENSTACK_VM_INSTANCE_TYPE
  • OPENSTACK_VM_NAME
  • OPENSTACK_VM_SECURITY_GROUP
  • PROCESS_GROUP_AZURE_HOST_NAME
  • PROCESS_GROUP_AZURE_SITE_NAME
  • PROCESS_GROUP_CUSTOM_METADATA
  • PROCESS_GROUP_DETECTED_NAME
  • PROCESS_GROUP_ID
  • PROCESS_GROUP_INSTANCE_CUSTOM_METADATA
  • PROCESS_GROUP_LISTEN_PORT
  • PROCESS_GROUP_NAME
  • PROCESS_GROUP_PREDEFINED_METADATA
  • PROCESS_GROUP_TAGS
  • PROCESS_GROUP_TECHNOLOGY
  • PROCESS_GROUP_TECHNOLOGY_EDITION
  • PROCESS_GROUP_TECHNOLOGY_VERSION
  • SERVICE_AKKA_ACTOR_SYSTEM
  • SERVICE_CTG_SERVICE_NAME
  • SERVICE_DATABASE_HOST_NAME
  • SERVICE_DATABASE_NAME
  • SERVICE_DATABASE_TOPOLOGY
  • SERVICE_DATABASE_VENDOR
  • SERVICE_DETECTED_NAME
  • SERVICE_IBM_CTG_GATEWAY_URL
  • SERVICE_IIB_APPLICATION_NAME
  • SERVICE_MESSAGING_LISTENER_CLASS_NAME
  • SERVICE_NAME
  • SERVICE_PORT
  • SERVICE_PUBLIC_DOMAIN_NAME
  • SERVICE_REMOTE_ENDPOINT
  • SERVICE_REMOTE_SERVICE_NAME
  • SERVICE_TAGS
  • SERVICE_TECHNOLOGY
  • SERVICE_TECHNOLOGY_EDITION
  • SERVICE_TECHNOLOGY_VERSION
  • SERVICE_TOPOLOGY
  • SERVICE_TYPE
  • SERVICE_WEB_APPLICATION_ID
  • SERVICE_WEB_CONTEXT_ROOT
  • SERVICE_WEB_SERVER_ENDPOINT
  • SERVICE_WEB_SERVER_NAME
  • SERVICE_WEB_SERVICE_NAME
  • SERVICE_WEB_SERVICE_NAMESPACE
  • VMWARE_DATACENTER_NAME
  • VMWARE_VM_NAME
  • WEB_APPLICATION_NAME
  • WEB_APPLICATION_NAME_PATTERN
  • WEB_APPLICATION_TAGS
  • WEB_APPLICATION_TYPE

Possible values for the items element in the AutoTagRule object:

  • HOST_TO_PROCESS_GROUP_INSTANCE
  • PROCESS_GROUP_TO_HOST
  • PROCESS_GROUP_TO_SERVICE
  • SERVICE_TO_HOST_LIKE
  • SERVICE_TO_PROCESS_GROUP_LIKE

Possible values for the type element in the AutoTagRule object:

  • AWS_CLASSIC_LOAD_BALANCER
  • AWS_RELATIONAL_DATABASE_SERVICE
  • CUSTOM_DEVICE
  • HOST
  • PROCESS_GROUP
  • SERVICE

Response format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Response codes

Code Description
201

Success. The auto tag has been created. The response body contains the generated ID.

400

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/autoTags/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/autoTags/validator

Response codes

Code Description
204 Validated. The submitted configuration is valid. Response does not have a body.
400 Failed. The input is invalid.

Example

In this example, the request creates a new auto tag for Services where the service name contains main. The services and hosts they're running on were assigned the MainApp tag.

The API token is passed in the Authorization header.

The request body is lengthy, so it is truncated in the Curl section. See the Request body section for the full body. You can download or copy the example request body to try it out on your own.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/autoTags \
  -H 'Authorization: Api-token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \  
  -d '{ <truncated - see the Request body section > }'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/autoTags

Request body

api-examples/config/autotag/post.json
Download
{
  "name": "MainApp",
  "rules": [
    {
      "type": "SERVICE",
      "enabled": true,
      "valueFormat": null,
      "propagationTypes": [
        "SERVICE_TO_HOST_LIKE"
      ],
      "conditions": [
        {
          "key": {
            "attribute": "SERVICE_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "CONTAINS",
            "value": "main",
            "negate": false,
            "caseSensitive": false
          }
        }
      ]
    }
  ]
}

Response body

{
  "id": "e3f5bfc1-ead4-4af8-9372-48beb05e03f9",
  "name": "MainApp"
}

Response code

201

Result

The new auto tag looks like this in the UI:

POST example