conditional naming API - GET all conditional naming rules

Lists all conditional naming rules available in your Dynatrace environment.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/config/v1/conditionalNaming/{type}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/conditionalNaming/{type}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/conditionalNaming/{type}`

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
type	string	The type of the rule, defined by the type of Dynatrace entities to which the rule applies. The element can hold these values `processGroup` `host` `service`	path	required

Response

The request returns the list of short representations of conditional naming rules—just ID, name, and description.

Response codes

Code	Type	Description
200	StubList	Success

Response body objects

The `StubList` object

An ordered list of short representations of Dynatrace entities.

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

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

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

Response body JSON model

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