Applications detection rules API - GET a rule

Gets parameters of the specified application detection rule.

The request produces an application/json payload.

GET

Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/{id}
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applicationDetectionRules/{id}
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/{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 Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the required application detection rule.	path	required

Response

Response codes

Code	Description
200	Success

Response body

Response parametersJSON model

The ApplicationDetectionRuleConfig object

Application detection rule.

Element	Type	Description
metadata	ConfigurationMetadataDtoImpl
id	string	The ID of the rule.
order	string	The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies.
applicationIdentifier	string	The Dynatrace entity ID of the application, for example `APPLICATION-4A3B43`. You must use an existing ID. If you need to create a rule for an application that doesn't exist yet, create an application first and then configure detection rules for it.
filterConfig	ApplicationFilter
name	string	The unique name of the Application detection rule.

The ApplicationFilter object

The condition of an application detection rule.

Element	Type	Description
pattern	string	The value to look for.
applicationMatchType	string	The operator of the matching. The element can hold these values BEGINS_WITH CONTAINS ENDS_WITH EQUALS MATCHES
applicationMatchTarget	string	Where to look for the the pattern value. The element can hold these values DOMAIN URL

Element

Type

Description

pattern

string

The value to look for.

applicationMatchType

string

The operator of the matching.

The element can hold these values

BEGINS_WITH
CONTAINS
ENDS_WITH
EQUALS
MATCHES

applicationMatchTarget

string

Where to look for the the pattern value.

The element can hold these values

DOMAIN
URL

The ConfigurationMetadataDtoImpl object

Metadata useful for debugging.

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

    {
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "clusterVersion": "Mock version"
  },
  "id": "12345678-abcd-1234-abcd-1234567890ab",
  "applicationIdentifier": "APPLICATION-123456",
  "name": "uniqueName",
  "filterConfig": {
    "pattern": "myapp.example.com",
    "applicationMatchType": "EQUALS",
    "applicationMatchTarget": "DOMAIN"
  }
}

Example

In this example, the request gets the properties of the easyTravel rule, which has the ID 95b22afb-4e3d-4f9f-a37d-81bc3d388a33.

The API token is passed in the Authorization header.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/applicationDetectionRules/95b22afb-4e3d-4f9f-a37d-81bc3d388a33 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/applicationDetectionRules/95b22afb-4e3d-4f9f-a37d-81bc3d388a33

Response body

{
  "metadata": {
    "configurationVersions": [
      0
    ],
    "clusterVersion": "1.188.0.20200203-155649"
  },
  "id": "95b22afb-4e3d-4f9f-a37d-81bc3d388a33",
  "applicationIdentifier": "APPLICATION-900C1E36674F607D",
  "filterConfig": {
    "pattern": "easyTravel",
    "applicationMatchType": "EQUALS",
    "applicationMatchTarget": "DOMAIN"
  }
}

Response code

200