• Home
  • Dynatrace API
  • Configuration
  • Services
  • Detection rules
  • Opaque web service
  • PUT reorder rules

Service detection API - PUT reorder opaque web service rules

Reorders the service detection rules for external and opaque web services to the order of the IDs in the body of the request.

Rules that are omitted from the body of the request retain their relative order but are placed after all those present in the request.

The request consumes and produces an application/json payload.

PUTManaged https://{your-domain}/e/{your-environment-id}/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/order
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/order
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/order

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

ParameterTypeDescriptionInRequired
bodyStubList

The JSON body of the request containing the service detection rules in the required order.

bodyoptional

Request body objects

The StubList object

An ordered list of short representations of Dynatrace entities.

ElementTypeDescription
valuesEntityShortRepresentation[]

An ordered list of short representations of Dynatrace entities.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Can be null.

descriptionstring

A short description of the Dynatrace entity.

Can be null.

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

CodeTypeDescription
204-

Success. Service detection rules have been reordered. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Related topics
  • Service detection and naming

    Find out what Dynatrace looks for when detecting and naming different types of services.

  • Opaque services

    Understand what opaque services are.