Automatically applied tags API - GET an auto-tag

Gets parameters of the specified automatically applied tag.

The request produces an application/json payload.

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

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Authentication.

Parameters

Parameter Type Description In Required

string

Parameter	Type	Description	In	Required
id	string	The ID of the required auto-tag.	path	required
includeProcessGroupReferences	boolean	Flag to include process group references to the response. Process group references aren't compatible across environments. When this flag is set to `false`, conditions with process group references are removed. If that results in a rule having no conditions, the entire rule is removed.	query	optional

The ID of the required auto-tag.

path

required

includeProcessGroupReferences

boolean

Flag to include process group references to the response.

Process group references aren't compatible across environments.

When this flag is set to false, conditions with process group references are removed. If that results in a rule having no conditions, the entire rule is removed.

query

optional

Response format

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

Response parameters JSON model

The AutoTag object

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

Element	Type	Description
metadata	ConfigurationMetadata
id	string	The ID of the auto-tag.
name	string	The name of the auto-tag, which is applied to entities. Additionally you can specify a valueFormat in the tag rule. In that case the tag is used in the `name:valueFormat` format. For example you can extend the `Infrastructure` tag to `Infrastructure:Windows` and `Infrastructure:Linux`.
rules	AutoTagRule[]	The list of rules for tag usage. When there are multiple rules, the OR logic applies.

The AutoTagRule object

A rule for the auto-tag.

Defines the conditions of tag usage.

Element	Type	Description
type	string	Type of entities to which the rule applies. The type element can hold these values.
enabled	boolean	Tag rule is enabled (`true`) or disabled (`false`).
valueFormat	string	The value of the auto-tag. If specified, the tag is used in the `name:valueFormat` format. For example, you can extend the `Infrastructure` tag to `Infrastructure:Windows` and `Infrastructure:Linux`. You can use the following placeholders here: `{AwsAutoScalingGroup:Name}` `{AwsAvailabilityZone:Name}` `{AwsElasticLoadBalancer:Name}` `{AwsRelationalDatabaseService:DBName}` `{AwsRelationalDatabaseService:Endpoint}` `{AwsRelationalDatabaseService:Engine}` `{AwsRelationalDatabaseService:InstanceClass}` `{AwsRelationalDatabaseService:Name}` `{AwsRelationalDatabaseService:Port}` `{AzureRegion:Name}` `{AzureScaleSet:Name}` `{AzureVm:Name}` `{CloudFoundryOrganization:Name}` `{CustomDevice:DetectedName}` `{CustomDevice:DnsName}` `{CustomDevice:IpAddress}` `{CustomDevice:Port}` `{DockerContainerGroupInstance:ContainerName}` `{DockerContainerGroupInstance:FullImageName}` `{DockerContainerGroupInstance:ImageVersion}` `{DockerContainerGroupInstance:StrippedImageName}` `{ESXIHost:HardwareModel}` `{ESXIHost:HardwareVendor}` `{ESXIHost:Name}` `{ESXIHost:ProductName}` `{ESXIHost:ProductVersion}` `{Ec2Instance:AmiId}` `{Ec2Instance:BeanstalkEnvironmentName}` `{Ec2Instance:InstanceId}` `{Ec2Instance:InstanceType}` `{Ec2Instance:LocalHostName}` `{Ec2Instance:Name}` `{Ec2Instance:PublicHostName}` `{Ec2Instance:SecurityGroup}` `{GoogleComputeInstance:Id}` `{GoogleComputeInstance:IpAddresses}` `{GoogleComputeInstance:MachineType}` `{GoogleComputeInstance:Name}` `{GoogleComputeInstance:ProjectId}` `{GoogleComputeInstance:Project}` `{Host:AWSNameTag}` `{Host:AixLogicalCpuCount}` `{Host:AzureHostName}` `{Host:AzureSiteName}` `{Host:BoshDeploymentId}` `{Host:BoshInstanceId}` `{Host:BoshInstanceName}` `{Host:BoshName}` `{Host:BoshStemcellVersion}` `{Host:CpuCores}` `{Host:DetectedName}` `{Host:Environment:AppName}` `{Host:Environment:BoshReleaseVersion}` `{Host:Environment:Environment}` `{Host:Environment:Link}` `{Host:Environment:Organization}` `{Host:Environment:Owner}` `{Host:Environment:Support}` `{Host:IpAddress}` `{Host:LogicalCpuCores}` `{Host:OneAgentCustomHostName}` `{Host:OperatingSystemVersion}` `{Host:PaasMemoryLimit}` `{HostGroup:Name}` `{KubernetesCluster:Name}` `{KubernetesNode:DetectedName}` `{OpenstackAvailabilityZone:Name}` `{OpenstackZone:Name}` `{OpenstackComputeNode:Name}` `{OpenstackProject:Name}` `{OpenstackVm:UnstanceType}` `{OpenstackVm:Name}` `{OpenstackVm:SecurityGroup}` `{ProcessGroup:AmazonECRImageAccountId}` `{ProcessGroup:AmazonECRImageRegion}` `{ProcessGroup:AmazonECSCluster}` `{ProcessGroup:AmazonECSContainerName}` `{ProcessGroup:AmazonECSFamily}` `{ProcessGroup:AmazonECSRevision}` `{ProcessGroup:AmazonLambdaFunctionName}` `{ProcessGroup:AmazonRegion}` `{ProcessGroup:ApacheConfigPath}` `{ProcessGroup:ApacheSparkMasterIpAddress}` `{ProcessGroup:AspDotNetCoreApplicationPath}` `{ProcessGroup:AspDotNetCoreApplicationPath}` `{ProcessGroup:AzureHostName}` `{ProcessGroup:AzureSiteName}` `{ProcessGroup:CassandraClusterName}` `{ProcessGroup:CatalinaBase}` `{ProcessGroup:CatalinaHome}` `{ProcessGroup:CloudFoundryAppId}` `{ProcessGroup:CloudFoundryAppName}` `{ProcessGroup:CloudFoundryInstanceIndex}` `{ProcessGroup:CloudFoundrySpaceId}` `{ProcessGroup:CloudFoundrySpaceName}` `{ProcessGroup:ColdFusionJvmConfigFile}` `{ProcessGroup:ColdFusionServiceName}` `{ProcessGroup:CommandLineArgs}` `{ProcessGroup:DetectedName}` `{ProcessGroup:DotNetCommandPath}` `{ProcessGroup:DotNetCommand}` `{ProcessGroup:DotNetClusterId}` `{ProcessGroup:DotNetNodeId}` `{ProcessGroup:ElasticsearchClusterName}` `{ProcessGroup:ElasticsearchNodeName}` `{ProcessGroup:EquinoxConfigPath}` `{ProcessGroup:ExeName}` `{ProcessGroup:ExePath}` `{ProcessGroup:GlassFishDomainName}` `{ProcessGroup:GlassFishInstanceName}` `{ProcessGroup:GoogleAppEngineInstance}` `{ProcessGroup:GoogleAppEngineService}` `{ProcessGroup:GoogleCloudProject}` `{ProcessGroup:HybrisBinDirectory}` `{ProcessGroup:HybrisConfigDirectory}` `{ProcessGroup:HybrisConfigDirectory}` `{ProcessGroup:HybrisDataDirectory}` `{ProcessGroup:IBMCicsRegion}` `{ProcessGroup:IBMCtgName}` `{ProcessGroup:IBMImsConnectRegion}` `{ProcessGroup:IBMImsControlRegion}` `{ProcessGroup:IBMImsMessageProcessingRegion}` `{ProcessGroup:IBMImsSoapGwName}` `{ProcessGroup:IBMIntegrationNodeName}` `{ProcessGroup:IBMIntegrationServerName}` `{ProcessGroup:IISAppPool}` `{ProcessGroup:IISRoleName}` `{ProcessGroup:JbossHome}` `{ProcessGroup:JbossMode}` `{ProcessGroup:JbossServerName}` `{ProcessGroup:JavaJarFile}` `{ProcessGroup:JavaJarPath}` `{ProcessGroup:JavaMainCLass}` `{ProcessGroup:KubernetesBasePodName}` `{ProcessGroup:KubernetesContainerName}` `{ProcessGroup:KubernetesFullPodName}` `{ProcessGroup:KubernetesNamespace}` `{ProcessGroup:KubernetesPodUid}` `{ProcessGroup:MssqlInstanceName}` `{ProcessGroup:NodeJsAppBaseDirectory}` `{ProcessGroup:NodeJsAppName}` `{ProcessGroup:NodeJsScriptName}` `{ProcessGroup:OracleSid}` `{ProcessGroup:PHPScriptPath}` `{ProcessGroup:PHPWorkingDirectory}` `{ProcessGroup:Ports}` `{ProcessGroup:RubyAppRootPath}` `{ProcessGroup:RubyScriptPath}` `{ProcessGroup:SoftwareAGInstallRoot}` `{ProcessGroup:SoftwareAGProductPropertyName}` `{ProcessGroup:SpringBootAppName}` `{ProcessGroup:SpringBootProfileName}` `{ProcessGroup:SpringBootStartupClass}` `{ProcessGroup:TIBCOBusinessWorksAppNodeName}` `{ProcessGroup:TIBCOBusinessWorksAppSpaceName}` `{ProcessGroup:TIBCOBusinessWorksCeAppName}` `{ProcessGroup:TIBCOBusinessWorksCeVersion}` `{ProcessGroup:TIBCOBusinessWorksDomainName}` `{ProcessGroup:TIBCOBusinessWorksEnginePropertyFilePath}` `{ProcessGroup:TIBCOBusinessWorksEnginePropertyFile}` `{ProcessGroup:TIBCOBusinessWorksHome}` `{ProcessGroup:VarnishInstanceName}` `{ProcessGroup:WebLogicClusterName}` `{ProcessGroup:WebLogicDomainName}` `{ProcessGroup:WebLogicHome}` `{ProcessGroup:WebLogicName}` `{ProcessGroup:WebSphereCellName}` `{ProcessGroup:WebSphereClusterName}` `{ProcessGroup:WebSphereNodeName}` `{ProcessGroup:WebSphereServerName}` `{ProcessGroup:ActorSystem}` `{Service:STGServerName}` `{Service:DatabaseHostName}` `{Service:DatabaseName}` `{Service:DatabaseVendor}` `{Service:DetectedName}` `{Service:EndpointPath}` `{Service:EndpointPathGatewayUrl}` `{Service:IIBApplicationName}` `{Service:MessageListenerClassName}` `{Service:Port}` `{Service:PublicDomainName}` `{Service:RemoteEndpoint}` `{Service:RemoteName}` `{Service:WebApplicationId}` `{Service:WebContextRoot}` `{Service:WebServerName}` `{Service:WebServiceNamespace}` `{Service:WebServiceName}` `{VmwareDatacenter:Name}` `{VmwareVm:Name}`
propagationTypes	string[]	How to apply the 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. `AZURE_TO_PG`: Apply to process groups connected to matching Azure entities. `AZURE_TO_SERVICE`: Apply to services provided by matching Azure entities.
conditions	EntityRuleEngineCondition[]	A list of matching rules for the auto-tag. The tag applies only when all conditions are fulfilled.

The EntityRuleEngineCondition object

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

Element	Type	Description
key	ConditionKey
comparisonInfo	ComparisonBasic

The ComparisonBasic object

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

The actual set of fields and possible values of the operator field depend on the type of the comparison. \n\nFind the list of actual models in the description of the type field and check the description of the model you need.

Element	Type	Description
operator	object	Operator of the comparison. You can reverse it by setting negate to `true`. Possible values depend on the type of the comparison. Find the list of actual models in the description of the type field and check the description of the model you need.
value	object	The value to compare to.
negate	boolean	Reverses the comparison operator. For example it turns the begins with into does not begin with.
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `STRING` -> StringComparison `INDEXED_NAME` -> IndexedNameComparison `INDEXED_STRING` -> IndexedStringComparison `INTEGER` -> IntegerComparison `SERVICE_TYPE` -> ServiceTypeComparison `PAAS_TYPE` -> PaasTypeComparison `CLOUD_TYPE` -> CloudTypeComparison `AZURE_SKU` -> AzureSkuComparision `AZURE_COMPUTE_MODE` -> AzureComputeModeComparison `ENTITY_ID` -> EntityIdComparison `SIMPLE_TECH` -> SimpleTechComparison `SIMPLE_HOST_TECH` -> SimpleHostTechComparison `SERVICE_TOPOLOGY` -> ServiceTopologyComparison `DATABASE_TOPOLOGY` -> DatabaseTopologyComparison `OS_TYPE` -> OsTypeComparison `HYPERVISOR_TYPE` -> HypervisorTypeComparision `IP_ADDRESS` -> IpAddressComparison `OS_ARCHITECTURE` -> OsArchitectureComparison `BITNESS` -> BitnessComparision `APPLICATION_TYPE` -> ApplicationTypeComparison `MOBILE_PLATFORM` -> MobilePlatformComparison `CUSTOM_APPLICATION_TYPE` -> CustomApplicationTypeComparison `DCRUM_DECODER_TYPE` -> DcrumDecoderComparison `SYNTHETIC_ENGINE_TYPE` -> SyntheticEngineTypeComparison `TAG` -> TagComparison `INDEXED_TAG` -> IndexedTagComparison The type element can hold these values.

The ConditionKey object

The key to identify the data we're matching.

The actual set of fields and possible values vary, depending on the type of the key.

Find the list of actual objects in the description of the type field.

Element Type Description

attribute

string

Element	Type	Description
attribute	string	The attribute to be used for comparision. The attribute element can hold these values.
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `PROCESS_CUSTOM_METADATA_KEY` -> CustomProcessMetadataConditionKey `HOST_CUSTOM_METADATA_KEY` -> CustomHostMetadataConditionKey `PROCESS_PREDEFINED_METADATA_KEY` -> ProcessMetadataConditionKey `STRING` -> StringConditionKey The type element can hold these values.

The attribute to be used for comparision.

The attribute element can hold these values.

type

string

Defines the actual set of fields depending on the value. See one of the following objects:

PROCESS_CUSTOM_METADATA_KEY -> CustomProcessMetadataConditionKey
HOST_CUSTOM_METADATA_KEY -> CustomHostMetadataConditionKey
PROCESS_PREDEFINED_METADATA_KEY -> ProcessMetadataConditionKey
STRING -> StringConditionKey

The type element can hold these values.

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.
clusterVersion	string	Dynatrace server version.

    
{
  "name": "sampleAutoTag",
  "rules": [
    {
      "type": "SERVICE",
      "enabled": true,
      "valueFormat": "myTagValue {Service:DetectedName}",
      "propagationTypes": [
        "SERVICE_TO_HOST_LIKE"
      ],
      "conditions": [
        {
          "key": {
            "attribute": "SERVICE_DATABASE_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "BEGINS_WITH",
            "value": "sample",
            "negate": false,
            "caseSensitive": false
          }
        },
        {
          "key": {
            "attribute": "SERVICE_WEB_SERVER_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "EXISTS",
            "negate": false
          }
        },
        {
          "key": {
            "attribute": "PROCESS_GROUP_CUSTOM_METADATA",
            "type": "PROCESS_CUSTOM_METADATA_KEY",
            "dynamicKey": {
              "source": "KUBERNETES",
              "key": "kubernetes.io/limit-ranger"
            }
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "BEGINS_WITH",
            "value": "sample",
            "negate": false,
            "caseSensitive": false
          }
        }
      ]
    }
  ]
}

Possible values

Possible values for the type element in the ComparisonBasic object:

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

Possible values for the type element in the ConditionKey object:

HOST_CUSTOM_METADATA_KEY
PROCESS_CUSTOM_METADATA_KEY
PROCESS_PREDEFINED_METADATA_KEY
STRING

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_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_ENTITY_NAME
AZURE_ENTITY_TAGS
AZURE_MGMT_GROUP_NAME
AZURE_MGMT_GROUP_UUID
AZURE_REGION_NAME
AZURE_SCALE_SET_NAME
AZURE_SUBSCRIPTION_NAME
AZURE_SUBSCRIPTION_UUID
AZURE_TENANT_NAME
AZURE_TENANT_UUID
AZURE_VM_NAME
BROWSER_MONITOR_NAME
BROWSER_MONITOR_TAGS
CLOUD_APPLICATION_LABELS
CLOUD_APPLICATION_NAME
CLOUD_APPLICATION_NAMESPACE_LABELS
CLOUD_APPLICATION_NAMESPACE_NAME
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_CPU_CORES
HOST_CUSTOM_METADATA
HOST_DETECTED_NAME
HOST_GROUP_ID
HOST_GROUP_NAME
HOST_HYPERVISOR_TYPE
HOST_IP_ADDRESS
HOST_KUBERNETES_LABELS
HOST_LOGICAL_CPU_CORES
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_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_ESB_APPLICATION_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 propagationTypes element in the AutoTagRule object:

AZURE_TO_PG
AZURE_TO_SERVICE
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:

APPLICATION
AWS_APPLICATION_LOAD_BALANCER
AWS_CLASSIC_LOAD_BALANCER
AWS_NETWORK_LOAD_BALANCER
AWS_RELATIONAL_DATABASE_SERVICE
AZURE
CUSTOM_APPLICATION
CUSTOM_DEVICE
DCRUM_APPLICATION
ESXI_HOST
EXTERNAL_SYNTHETIC_TEST
HOST
HTTP_CHECK
KUBERNETES_NODE
MOBILE_APPLICATION
PROCESS_GROUP
SERVICE
SYNTHETIC_TEST

Example

In this example, the request inquires about the properties of the Infrastructure - Linux" auto-tag, which has the ID 7c82c170-b380-4fa7-992a-453f3e73047b.

The configuration has the following settings:

GET example

The API token is passed in the Authorization header.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/autoTags/7c82c170-b380-4fa7-992a-453f3e73047b \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/autoTags/7c82c170-b380-4fa7-992a-453f3e73047b

Response body

{
  "metadata": {
    "configurationVersions": [
      7
    ],
    "clusterVersion": "1.176.0.20190808-181828"
  },
  "id": "7c82c170-b380-4fa7-992a-453f3e73047b",
  "name": "Infrastructure - Linux",
  "rules": [
    {
      "type": "HOST",
      "enabled": true,
      "valueFormat": "prodLinux",
      "propagationTypes": [],
      "conditions": [
        {
          "key": {
            "attribute": "HOST_OS_TYPE"
          },
          "comparisonInfo": {
            "type": "OS_TYPE",
            "operator": "EQUALS",
            "value": "LINUX",
            "negate": false
          }
        },
        {
          "key": {
            "attribute": "HOST_NAME"
          },
          "comparisonInfo": {
            "type": "STRING",
            "operator": "BEGINS_WITH",
            "value": "PreProd",
            "negate": true,
            "caseSensitive": true
          }
        }
      ]
    }
  ]
}

Response code

200