Applications detection rules API - PUT reorder rules

Application detection rules are evaluated from top to bottom, the first matching rule applies.

This request reorders the application detection rules according to the order of the IDs in the body of the request. Rules that are omitted in the body of the request will retain their relative order but will be placed after all those present in the request.

The request consumes an application/json payload.

PUT	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/order`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/applicationDetectionRules/order`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/order`

Authentication

To execute this request, you need Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	StubList	The JSON body of the request. Contains the IDs of the application detection rules in the desired order. Any further properties (name, description) are ignored.	body	optional

Request body objects

The `StubList` object

An ordered list of short representations of Dynatrace entities.

Element	Type	Description	Required
values	EntityShortRepresentation[]	An ordered list of short representations of Dynatrace entities.	required

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description	Required
id	string	The ID of the Dynatrace entity.	required
name	string	The name of the Dynatrace entity.	optional
description	string	A short description of the Dynatrace entity.	optional

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.

json
{
  "values": [
    {
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Dynatrace entity 1",
      "description": "Dynatrace entity 1 for the REST API example"
    },
    {
      "id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
      "name": "Dynatrace entity 2"
    },
    {
      "id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
    }
  ]
}

Response

Response codes

Code	Type	Description
204	-	Success. Application detection rules have been reordered. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.

Example

In this example, the request reorders the detection rules from GET all rules request example, enforcing the following order:

PaymentProcessing
BookingApp
easyTravel

Curl

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

Request URL

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

Request body

json
{
  "values": [
    {
      "id": "498a4b9a-d551-4556-ac9a-4075200b28ae",
      "name": "PaymentProcessing"
    },
    {
      "id": "9568a82b-73d8-4b18-be1a-4289433e2619",
      "name": "BookingApp"
    },
    {
      "id": "95b22afb-4e3d-4f9f-a37d-81bc3d388a33",
      "name": "easyTravel"
    }
  ]
}

Response code

204