Conditional naming API - POST a new naming rule
Creates a new conditional naming rule.
The request consumes and produces an application/json payload.
| POST | 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 WriteConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Refer to JSON models to find all JSON models that depend on the type of the model.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| type | string | The type of the rule, defined by the type of Dynatrace entities to which the rule applies. | path | required |
| body | Conditional | The JSON body of the request. Contains parameters of the new naming rule. Do not specify the id of the rule. The value of the type field must match the type path parameter. | body | optional |
Request body objects
The ConditionalNamingRule object
The rule for the conditional naming.
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | optional |
| id | string | The ID of the naming rule. | optional |
| type | string | The type of Dynatrace entities to which the rule applies. | required |
| nameFormat | string | The name to be assigned to matching entities. You can use the following placeholders here:
| required |
| displayName | string | The name of the rule | required |
| enabled | boolean | The rule is enabled ( | required |
| rules | Entity | A list of matching conditions of the rule. The rule applies only if all conditions are fulfilled. | required |
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 EntityRuleEngineCondition object
A condition defines how to execute matching logic for an entity.
| Element | Type | Description | Required |
|---|---|---|---|
| key | Condition | The key to identify the data we're matching. The actual set of fields and possible values depend on the type of the key. Find the list of actual objects in the description of the type field or see JSON models. | required |
| comparisonInfo | Comparison | Defines how the matching is actually performed: what and how are we comparing. The actual set of fields and possible values of the operator field depend on the type of the comparison. Find the list of actual objects in the description of the type field or see JSON models. | required |
The ConditionKey object
The key to identify the data we're matching.
The actual set of fields and possible values depend on the type of the key. Find the list of actual objects in the description of the type field or see JSON models.
| Element | Type | Description | Required |
|---|---|---|---|
| attribute | string | The attribute to be used for comparison. | required |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
| optional |
The ComparisonBasic object
Defines how the matching is actually performed: what and how are we comparing.
The actual set of fields and possible values of the operator field depend on the type of the comparison. Find the list of actual objects in the description of the type field or see JSON models.
| Element | Type | Description | Required |
|---|---|---|---|
| operator | string | Operator of the comparison. You can reverse it by setting negate to Possible values depend on the type of the comparison. Find the list of actual models in the description of the type field and check the description of the model you need. | required |
| value | object | The value to compare to. | optional |
| negate | boolean | Reverses the comparison operator. For example it turns the begins with into does not begin with. | required |
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
| 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.
{
"id": "4e88530c-edec-4e31-9cb4-3f2c63abc2b7",
"type": "PROCESS_GROUP",
"nameFormat": "TestNameFormat",
"displayName": "TestRule",
"enabled": true,
"rules": [
{
"key": {
"attribute": "PROCESS_GROUP_TECHNOLOGY"
},
"comparisonInfo": {
"type": "SIMPLE_TECH",
"operator": "EQUALS",
"value": {
"type": "JAVA"
},
"negate": "false"
}
},
{
"key": {
"attribute": "PROCESS_GROUP_PREDEFINED_METADATA",
"dynamicKey": "EXE_NAME",
"type": "PROCESS_PREDEFINED_METADATA_KEY"
},
"comparisonInfo": {
"type": "STRING",
"operator": "CONTAINS",
"value": "test",
"negate": "false",
"caseSensitive": true
}
}
]
}Response
The request returns the short representation of the newly created rule.
Response codes
| Code | Type | Description |
|---|---|---|
| 201 | Entity | Success. The naming rule has been created. The response contains the ID of the new rule |
| 400 | ErrorEnvelope | Failed. The input is invalid. |
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the Dynatrace entity. |
| name | string | The name of the Dynatrace entity. |
| description | string | A short description of the Dynatrace entity. |
Response body JSON model
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/conditionalNaming/{type}/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/conditionalNaming/{type}/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/conditionalNaming/{type}/validator |
Authentication
To execute this request, you need an access token with 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 doesn't have a body. | |
| 400 | ErrorEnvelope | Failed. The input is invalid. |