Applications detection rules API - GET a rule
Gets parameters of the specified application detection rule.
The request produces an application/json
payload.
GET |
|
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
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 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 |
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. |
applicationMatchTarget | string | Where to look for the the pattern value. |
The ConfigurationMetadataDtoImpl object
Metadata useful for debugging.
Element | Type | Description |
---|---|---|
currentConfigurationVersions | string[] | A Sorted list of string version numbers of the configuration. |
configurationVersions | integer[] | A Sorted list of the version numbers of the configuration. |
clusterVersion | string | Dynatrace server version. |
{
"metadata": {
"configurationVersions": [
4,
2
],
"clusterVersion": "Mock version"
},
"id": "12345678-abcd-1234-abcd-1234567890ab",
"applicationIdentifier": "APPLICATION-123456",
"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 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