Custom services API - GET a custom service rule

Gets parameters of the specified custom service rule.

The request produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/customServices/{technology}/{id}
  • SaaS https://{your-environment-id}{technology}/{id}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/customServices/{technology}/{id}


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


Parameter Type Description In Required
technology string

Technology of the custom service you're inquiring.

path required
id string

The ID of the custom service you're inquiring.

path required
includeProcessGroupReferences boolean

Flag to include process group references to the response.

Process group references aren't compatible across environments.

false is used if the value is not set.

query optional


Response codes

Code Description


Response body

The CustomService object

Element Type Description
metadata ConfigurationMetadata
id string

The ID of the custom service.

name string

The name of the custom service, displayed in the UI.

order string

The order string. Sorting custom services alphabetically by their order string determines their relative ordering.

Typically this is managed by Dynatrace internally and will not be present in GET responses.

enabled boolean

Custom service enabled/disabled.

rules DetectionRule[]

The list of rules defining the custom service.

queueEntryPoint boolean

The queue entry point flag.

Set to true for custom messaging services.

queueEntryPointType string

The queue entry point type..

processGroups string[]

The list of process groups the custom service should belong to.

The DetectionRule object

Element Type Description
id string

The ID of the detection rule.

enabled boolean

Rule enabled/disabled.

fileName string

The PHP file containing the class or methods to instrument.

Required for PHP custom service.

Not applicable to Java and .NET.

fileNameMatcher string

Matcher applying to the file name. Default value is ENDS_WITH (if applicable).

className string

The fully qualified class or interface to instrument.

Required for Java and .NET custom services.

Not applicable to PHP.

matcher string

Matcher applying to the class name. STARTS_WITH can only be used if there is at least one annotation defined. Default value is EQUALS.

methodRules MethodRule[]

List of methods to instrument.

annotations string[]

Additional annotations filter of the rule.

Only classes where all listed annotations are available in the class itself or any of its superclasses are instrumented.

Not applicable to PHP.

The MethodRule object

Element Type Description
id string

The ID of the method rule.

methodName string

The method to instrument.

argumentTypes string[]

Fully qualified types of argument the method expects.

returnType string

Fully qualified type the method returns.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersions string[]

A sorted list of version numbers of the configuration.

clusterVersion string

Dynatrace version.