Try it free

Custom services API - GET all custom service rules

  • Reference
  • Published Sep 02, 2019

Lists all custom service rules available in your Dynatrace environment.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/customServices/{technology}
GETEnvironment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/customServices/{technology}

Authentication

Api-Token:

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

To learn how to obtain and use it, see Personal access tokens.

Platform Token / OAuth:

Required scope: settings:objects:read

To learn how to obtain and use it, see Platform tokens or OAuth clients.

Parameters

ParameterTypeDescriptionInRequired
technologystring

Technology of the required custom services.

The element can hold these values
  • dotNet
  • go
  • java
  • nodeJS
  • php
pathRequired

Response

Response codes

CodeTypeDescription
200StubList

Success

Response 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
descriptionstring

A short description of the Dynatrace entity.

idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Response body JSON models

{
"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"
}
]
}

Related topics

  • Define custom services