Custom services API - PUT a custom service rule

PUT a custom service rule

Updates the specified custom service rule.

The request consumes and produces an application/json payload.

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

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

Parameter Type Description In Required

technology

string

Parameter	Type	Description	In	Required
technology	string	Technology of the custom service to update. The element can hold these values `dotNet` `go` `java` `nodeJS` `php`	path	required
id	string	The ID of the custom service to update. The ID of the custom service in the body of the request must match this ID.	path	required
body	CustomService	JSON body of the request containing updated definition of the custom service. If order is present, it will be used.	body	optional

Technology of the custom service to update.

The element can hold these values

dotNet
go
java
nodeJS
php

path

required

string

The ID of the custom service to update.

The ID of the custom service in the body of the request must match this ID.

path

required

body

CustomService

JSON body of the request containing updated definition of the custom service. If order is present, it will be used.

body

optional

Request body objects

The `CustomService` object

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging Can be `null`.
id	string	The ID of the custom service. Can be `null`.
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. Can be `null`.
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.. The element can hold these values `IBM_MQ` `JMS` `KAFKA` `MSMQ` `RABBIT_MQ` Can be `null`.
processGroups	string[]	The list of process groups the custom service should belong to. Can be `null`.

The `ConfigurationMetadata` object

Metadata useful for debugging

Element Type Description

configurationVersions

integer[]

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration. Can be `null`.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration. Can be `null`.
clusterVersion	string	Dynatrace version. Can be `null`.

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersions

string[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersion

string

Dynatrace version.

Can be null.

The `DetectionRule` object

Element	Type	Description
id	string	The ID of the detection rule. Can be `null`.
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. Can be `null`.
fileNameMatcher	string	Matcher applying to the file name. Default value is `ENDS_WITH` (if applicable). The element can hold these values `ENDS_WITH` `EQUALS` `STARTS_WITH` Can be `null`.
className	string	The fully qualified class or interface to instrument. Required for Java and .NET custom services. Not applicable to PHP. Can be `null`.
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`. The element can hold these values `ENDS_WITH` `EQUALS` `STARTS_WITH` Can be `null`.
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. Can be `null`.

The `MethodRule` object

Element	Type	Description
id	string	The ID of the method rule. Can be `null`.
methodName	string	The method to instrument.
argumentTypes	string[]	Fully qualified types of argument the method expects. Can be `null`.
returnType	string	Fully qualified type the method returns.
visibility	string	The visibility of the method rule. The element can hold these values `INTERNAL` `PACKAGE_PROTECTED` `PRIVATE` `PROTECTED` `PUBLIC` Can be `null`.
modifiers	string[]	The modifiers of the method rule. The element can hold these values `ABSTRACT` `EXTERN` `FINAL` `NATIVE` `STATIC` 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
{
  "name": "CustomService",
  "enabled": true,
  "rules": [
    {
      "enabled": true,
      "className": "com.your.company.ClassName",
      "methodRules": [
        {
          "methodName": "AMethod",
          "argumentTypes": [
            "java.lang.String"
          ],
          "returnType": "void"
        }
      ]
    }
  ],
  "queueEntryPoint": false
}

Response

Response codes

Code	Type	Description
201	EntityShortRepresentation	Success. Custom service has been created. Response contains the new service's ID and name.
204	-	Success. Custom service has been updated. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid

Response body objects

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element Type Description

string

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

The ID of the Dynatrace entity.

name

string

The name of the Dynatrace entity.

Can be null.

description

string

A short description of the Dynatrace entity.

Can be null.

Response body JSON model

json
{
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity",
  "description": "Dynatrace entity for the REST API example"
}

Validate payload

{snippet name='dynatrace-api/validate-payload.md'}}

POST	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/service/customServices/{technology}/{id}/validator`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/customServices/{technology}/{id}/validator`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/customServices/{technology}/{id}/validator`

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.

Response

Response codes

Code	Type	Description
204	-	Validated. The submitted configuration is valid. Response does not have a body.
400	ErrorEnvelope	Failed. The input is invalid

Custom services API - PUT a custom service rule

PUT a custom service rule

Authentication

Parameters

Request body objects

The CustomService object

The ConfigurationMetadata object

The DetectionRule object

The MethodRule object

Request body JSON model

Response

Response codes

Response body objects

The EntityShortRepresentation object

Response body JSON model

Validate payload

Authentication

Response

Response codes

The `CustomService` object

The `ConfigurationMetadata` object

The `DetectionRule` object

The `MethodRule` object

The `EntityShortRepresentation` object