Applications detection rules API - POST a rule

Creates a new application detection rule and adds it to the end of the rules list. To enforce a particular order, use the PUT reorder rules request.

The request consumes and produces an application/json payload.

Parameters

The body must not provide an ID. An ID is assigned automatically by Dynatrace.

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

Response

jsoncopydownload
{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

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.

Response

Example

In this example, the request creates a new application detection rule for the BookingApp application that has the ID of APPLICATION-900C1E36674F607D.

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

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

Request URL

plaintextcopydownload
https://mySampleEnv.live.dynatrace.com/api/config/v1/applicationDetectionRules

Request body

jsoncopydownload
{
  "applicationIdentifier": "APPLICATION-900C1E36674F607D",
  "filterConfig": {
    "pattern": "booking",
    "applicationMatchType": "CONTAINS",
    "applicationMatchTarget": "URL"
  }
}

Response body

jsoncopydownload
{
  "id": "9568a82b-73d8-4b18-be1a-4289433e2619",
  "name": "BookingApp"
}

Response code

201

Result

The new application detection rule looks like this in the UI: