Applications detection rules API - PUT a rule
Updates the specified application detection rule.
If the application detection rule with the specified ID doesn't exist, a new rule is created and appended to the end of the rule list.
If the order parameter is set for an existing rule, the request uses this value. Otherwise, it keeps the existing order of rules.
The request consumes and produces an application/json payload.
| PUT | 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 an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the application detection rule to be updated. If you set the ID in the body as well, it must match this ID. | path | required |
| body | Application | The JSON body of the request. Contains updated parameters of the application detection rule. If the order parameter is set, the rule is placed to this position. | body | optional |
Request body objects
The ApplicationDetectionRuleConfig object
Application detection rule.
| Element | Type | Description |
|---|---|---|
| metadata | Configuration | Metadata useful for debugging. Can be |
| id | string | The ID of the rule. Can be |
| order | string | The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies. Can be |
| 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 | Application | The condition of an application detection rule. |
| name | string | The unique name of the Application detection rule. Can be |
The ConfigurationMetadataDtoImpl object
Metadata useful for debugging.
| Element | Type | Description |
|---|---|---|
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. Can be |
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. Can be |
| clusterVersion | string | Dynatrace version. Can be |
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. |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{
"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"
}
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 201 | Entity | Success. Application detection rule has been created. Response contains the ID of the new rule. |
| 204 | - | Success. Application detection rule has been updated. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |
Response body objects
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. Can be |
| description | string | A short description of the Dynatrace entity. Can be |
Response body JSON model
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}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.
The request consumes an application/json payload.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/{id}/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/applicationDetectionRules/{id}/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/{id}/validator |
Authentication
To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | - | Validated. The submitted configuration is valid. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |
Example
In this example, the request updates the application detection rule from the POST request example. It changes the order of the rule to position two and changes the condition of the rule to the domain that contains the booking.easyTravel pattern.
The API token is passed in the Authorization header.
The request body 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. Be sure to use an application ID that is available in your environment.
Curl
curl -X PUT \
https://mySampleEnv.live.dynatrace.com/api/config/v1/applicationDetectionRules/9568a82b-73d8-4b18-be1a-4289433e2619 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{ <truncated - see the Request body section > }'Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/applicationDetectionRules/9568a82b-73d8-4b18-be1a-4289433e2619Request body
{
"id": "9568a82b-73d8-4b18-be1a-4289433e2619",
"applicationIdentifier": "APPLICATION-900C1E36674F607D",
"order": 2,
"filterConfig": {
"pattern": "booking.easyTravel",
"applicationMatchType": "BEGINS_WITH",
"applicationMatchTarget": "DOMAIN"
}
}
Response code
204