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 Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| technology | string | Technology of the custom service to update. | path | optional |
| 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 | optional |
| body | Custom | 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 | Required |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | optional |
| id | string | The ID of the custom service. | optional |
| name | string | The name of the custom service, displayed in the UI. | required |
| 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. | optional |
| enabled | boolean | Custom service enabled/disabled. | required |
| rules | Detection | The list of rules defining the custom service. | required |
| queueEntryPoint | boolean | The queue entry point flag. Set to | required |
| queueEntryPointType | string | The queue entry point type.. | optional |
| processGroups | string[] | The list of process groups the custom service should belong to. | optional |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. | optional |
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. | optional |
| clusterVersion | string | Dynatrace version. | optional |
The DetectionRule object
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the detection rule. | optional |
| enabled | boolean | Rule enabled/disabled. | required |
| fileName | string | The PHP file containing the class or methods to instrument. Required for PHP custom service. Not applicable to Java and .NET. | optional |
| fileNameMatcher | string | Matcher applying to the file name. Default value is | optional |
| className | string | The fully qualified class or interface to instrument. Required for Java and .NET custom services. Not applicable to PHP. | optional |
| matcher | string | Matcher applying to the class name. | optional |
| methodRules | Method | List of methods to instrument. | required |
| 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. | optional |
The MethodRule object
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the method rule. | optional |
| methodName | string | The method to instrument. | required |
| argumentTypes | string[] | Fully qualified types of argument the method expects. | optional |
| returnType | string | Fully qualified type the method returns. | required |
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.
{
"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 | Entity | 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 | Error | Failed. The input is invalid |
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the Dynatrace entity. | required |
| name | string | The name of the Dynatrace entity. | optional |
| description | string | A short description of the Dynatrace entity. | optional |
Response body JSON model
{
"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 Write configuration (WriteConfig) permission assigned to your API token. 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 | Error | Failed. The input is invalid |