• Home
  • Dynatrace API
  • Configuration
  • Services
  • Request naming
  • POST a new rule

Request naming API - POST a new request naming rule

Creates a new request naming rule. See the detailed use case in the Request naming API - Create a new rule topic.

The request consumes and produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestNaming
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestNaming
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/requestNaming

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.

ParameterTypeDescriptionInRequired
positionstring

Order of the new request naming rule. Set to PREPEND to prepend it to the list, APPEND to append it. Defaults to APPEND.

The element can hold these values
  • APPEND
  • PREPEND
queryoptional
bodyRequestNaming

The JSON body of the request containing parameters of the new request naming rule.

You must not specify the ID of the rule!

bodyoptional

Request body objects

The RequestNaming object

The request naming rule.

ElementTypeDescriptionRequired
metadataConfigurationMetadata

Metadata useful for debugging

optional
idstring

The ID of the request naming rule.

optional
orderstring

The order string. Sorting request namings alphabetically by their order string determines their relative ordering.

Typically this is managed by Dynatrace internally and will not be present in GET responses nor used if present in PUT/POST requests, except where noted otherwise.

optional
enabledboolean

The rule is enabled (true) or disabled (false).

required
namingPatternstring

The name to be assigned to matching requests.

required
managementZonesstring[]

Specifies the management zones for which this rule should be applied.

optional
conditionsCondition[]

The set of conditions for the request naming rule usage.

You can specify several conditions. The request has to match all the specified conditions for the rule to trigger.

required
placeholdersPlaceholder[]

The list of custom placeholders to be used in the naming pattern.

It enables you to extract a request attribute value or other request attribute and use it in the request naming pattern.

optional

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional
clusterVersionstring

Dynatrace version.

optional

The Condition object

A condition of a rule usage.

ElementTypeDescriptionRequired
attributestring

The attribute to be matched.

Note that for a service property attribute you must use the comparison of the FAST_STRING type.

The element can hold these values
  • ACTOR_SYSTEM
  • AKKA_ACTOR_CLASS_NAME
  • AKKA_ACTOR_MESSAGE_TYPE
  • AKKA_ACTOR_PATH
  • APPLICATION_BUILD_VERSION
  • APPLICATION_ENVIRONMENT
  • APPLICATION_NAME
  • APPLICATION_RELEASE_VERSION
  • AZURE_FUNCTIONS_FUNCTION_NAME
  • AZURE_FUNCTIONS_SITE_NAME
  • CICS_PROGRAM_NAME
  • CICS_SYSTEM_ID
  • CICS_TASK_ID
  • CICS_TRANSACTION_ID
  • CICS_USER_ID
  • CPU_TIME
  • CTG_GATEWAY_URL
  • CTG_PROGRAM
  • CTG_SERVER_NAME
  • CTG_TRANSACTION_ID
  • CUSTOMSERVICE_CLASS
  • CUSTOMSERVICE_METHOD
  • DATABASE_CHILD_CALL_COUNT
  • DATABASE_CHILD_CALL_TIME
  • DATABASE_HOST
  • DATABASE_NAME
  • DATABASE_STATEMENT
  • DATABASE_TYPE
  • DATABASE_URL
  • DISK_IO_TIME
  • ERROR_COUNT
  • ESB_APPLICATION_NAME
  • ESB_INPUT_TYPE
  • ESB_LIBRARY_NAME
  • ESB_MESSAGE_FLOW_NAME
  • EXCEPTION_CLASS
  • EXCEPTION_MESSAGE
  • FAILED_STATE
  • FAILURE_REASON
  • FLAW_STATE
  • HTTP_REQUEST_METHOD
  • HTTP_STATUS
  • HTTP_STATUS_CLASS
  • IMS_PROGRAM_NAME
  • IMS_TRANSACTION_ID
  • IMS_USER_ID
  • IO_TIME
  • IS_KEY_REQUEST
  • LAMBDA_COLDSTART
  • LOCK_TIME
  • MESSAGING_DESTINATION_TYPE
  • MESSAGING_IS_TEMPORARY_QUEUE
  • MESSAGING_QUEUE_NAME
  • MESSAGING_QUEUE_VENDOR
  • NETWORK_IO_TIME
  • NON_DATABASE_CHILD_CALL_COUNT
  • NON_DATABASE_CHILD_CALL_TIME
  • PROCESS_GROUP_NAME
  • PROCESS_GROUP_TAG
  • REMOTE_ENDPOINT
  • REMOTE_METHOD
  • REMOTE_SERVICE_NAME
  • REQUEST_NAME
  • REQUEST_TYPE
  • RESPONSE_TIME
  • RESPONSE_TIME_CLIENT
  • RMI_CLASS
  • RMI_METHOD
  • SERVICE_DISPLAY_NAME
  • SERVICE_NAME
  • SERVICE_PORT
  • SERVICE_PUBLIC_DOMAIN_NAME
  • SERVICE_REQUEST_ATTRIBUTE
  • SERVICE_TAG
  • SERVICE_TYPE
  • SERVICE_WEB_APPLICATION_ID
  • SERVICE_WEB_CONTEXT_ROOT
  • SERVICE_WEB_SERVER_NAME
  • SERVICE_WEB_SERVICE_NAME
  • SERVICE_WEB_SERVICE_NAMESPACE
  • SUSPENSION_TIME
  • TOTAL_PROCESSING_TIME
  • WAIT_TIME
  • WEBREQUEST_QUERY
  • WEBREQUEST_RELATIVE_URL
  • WEBREQUEST_URL
  • WEBREQUEST_URL_HOST
  • WEBREQUEST_URL_PATH
  • WEBREQUEST_URL_PORT
  • WEBSERVICE_ENDPOINT
  • WEBSERVICE_METHOD
  • ZOS_CALL_TYPE
required
comparisonInfoComparisonInfo

Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.

required

The ComparisonInfo object

Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.

ElementTypeDescriptionRequired
comparisonstring

Operator of the comparision. You can reverse it by setting negate to true.

required
valueobject

The value to compare to.

optional
valuesobject[]

The values to compare to.

optional
negateboolean

Reverse the comparison operator. For example, it turns equals into does not equal.

required
typestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING -> StringComparisonInfo
  • NUMBER -> NumberComparisonInfo
  • BOOLEAN -> BooleanComparisonInfo
  • HTTP_METHOD -> HttpMethodComparisonInfo
  • STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo
  • NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo
  • ZOS_CALL_TYPE -> ZosComparisonInfo
  • IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo
  • ESB_INPUT_NODE_TYPE -> ESBInputNodeTypeComparisonInfo
  • FAILED_STATE -> FailedStateComparisonInfo
  • FLAW_STATE -> FlawStateComparisonInfo
  • FAILURE_REASON -> FailureReasonComparisonInfo
  • HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo
  • TAG -> TagComparisonInfo
  • FAST_STRING -> FastStringComparisonInfo
  • SERVICE_TYPE -> ServiceTypeComparisonInfo
The element can hold these values
  • BOOLEAN
  • ESB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FAILURE_REASON
  • FAST_STRING
  • FLAW_STATE
  • HTTP_METHOD
  • HTTP_STATUS_CLASS
  • IIB_INPUT_NODE_TYPE
  • NUMBER
  • NUMBER_REQUEST_ATTRIBUTE
  • SERVICE_TYPE
  • STRING
  • STRING_REQUEST_ATTRIBUTE
  • TAG
  • ZOS_CALL_TYPE
required

The Placeholder object

The custom placeholder to be used as a naming value pattern.

It enables you to extract a request attribute value or other request attribute and use it in the naming pattern.

ElementTypeDescriptionRequired
namestring

The name of the placeholder. Use it in the naming pattern as {name}.

required
attributestring

The attribute to extract from. You can only use attributes of the string type.

The element can hold these values
  • ACTOR_SYSTEM
  • AKKA_ACTOR_CLASS_NAME
  • AKKA_ACTOR_MESSAGE_TYPE
  • AKKA_ACTOR_PATH
  • APPLICATION_BUILD_VERSION
  • APPLICATION_ENVIRONMENT
  • APPLICATION_NAME
  • APPLICATION_RELEASE_VERSION
  • AZURE_FUNCTIONS_FUNCTION_NAME
  • AZURE_FUNCTIONS_SITE_NAME
  • CICS_PROGRAM_NAME
  • CICS_SYSTEM_ID
  • CICS_TASK_ID
  • CICS_TRANSACTION_ID
  • CICS_USER_ID
  • CPU_TIME
  • CTG_GATEWAY_URL
  • CTG_PROGRAM
  • CTG_SERVER_NAME
  • CTG_TRANSACTION_ID
  • CUSTOMSERVICE_CLASS
  • CUSTOMSERVICE_METHOD
  • DATABASE_CHILD_CALL_COUNT
  • DATABASE_CHILD_CALL_TIME
  • DATABASE_HOST
  • DATABASE_NAME
  • DATABASE_STATEMENT
  • DATABASE_TYPE
  • DATABASE_URL
  • DISK_IO_TIME
  • ERROR_COUNT
  • ESB_APPLICATION_NAME
  • ESB_INPUT_TYPE
  • ESB_LIBRARY_NAME
  • ESB_MESSAGE_FLOW_NAME
  • EXCEPTION_CLASS
  • EXCEPTION_MESSAGE
  • FAILED_STATE
  • FAILURE_REASON
  • FLAW_STATE
  • HTTP_REQUEST_METHOD
  • HTTP_STATUS
  • HTTP_STATUS_CLASS
  • IMS_PROGRAM_NAME
  • IMS_TRANSACTION_ID
  • IMS_USER_ID
  • IO_TIME
  • IS_KEY_REQUEST
  • LAMBDA_COLDSTART
  • LOCK_TIME
  • MESSAGING_DESTINATION_TYPE
  • MESSAGING_IS_TEMPORARY_QUEUE
  • MESSAGING_QUEUE_NAME
  • MESSAGING_QUEUE_VENDOR
  • NETWORK_IO_TIME
  • NON_DATABASE_CHILD_CALL_COUNT
  • NON_DATABASE_CHILD_CALL_TIME
  • PROCESS_GROUP_NAME
  • PROCESS_GROUP_TAG
  • REMOTE_ENDPOINT
  • REMOTE_METHOD
  • REMOTE_SERVICE_NAME
  • REQUEST_NAME
  • REQUEST_TYPE
  • RESPONSE_TIME
  • RESPONSE_TIME_CLIENT
  • RMI_CLASS
  • RMI_METHOD
  • SERVICE_DISPLAY_NAME
  • SERVICE_NAME
  • SERVICE_PORT
  • SERVICE_PUBLIC_DOMAIN_NAME
  • SERVICE_REQUEST_ATTRIBUTE
  • SERVICE_TAG
  • SERVICE_TYPE
  • SERVICE_WEB_APPLICATION_ID
  • SERVICE_WEB_CONTEXT_ROOT
  • SERVICE_WEB_SERVER_NAME
  • SERVICE_WEB_SERVICE_NAME
  • SERVICE_WEB_SERVICE_NAMESPACE
  • SUSPENSION_TIME
  • TOTAL_PROCESSING_TIME
  • WAIT_TIME
  • WEBREQUEST_QUERY
  • WEBREQUEST_RELATIVE_URL
  • WEBREQUEST_URL
  • WEBREQUEST_URL_HOST
  • WEBREQUEST_URL_PATH
  • WEBREQUEST_URL_PORT
  • WEBSERVICE_ENDPOINT
  • WEBSERVICE_METHOD
  • ZOS_CALL_TYPE
required
kindstring

The type of extraction.

Defines either usage of regular expression (regex) or the position of request attribute value to be extracted.

When the attribute is SERVICE_REQUEST_ATTRIBUTE attribute and aggregation is COUNT, needs to be set to ORIGINAL_TEXT

The element can hold these values
  • AFTER_DELIMITER
  • BEFORE_DELIMITER
  • BETWEEN_DELIMITER
  • ORIGINAL_TEXT
  • REGEX_EXTRACTION
required
delimiterOrRegexstring

Depending on the type value:

  • REGEX_EXTRACTION: The regular expression.
  • BETWEEN_DELIMITER: The opening delimiter string to look for.
  • All other values: The delimiter string to look for.
optional
endDelimiterstring

The closing delimiter string to look for.

Required if the kind value is BETWEEN_DELIMITER. Not applicable otherwise.

optional
requestAttributestring

The request attribute to extract from.

Required if the kind value is SERVICE_REQUEST_ATTRIBUTE. Not applicable otherwise.

optional
normalizationstring

The format of the extracted string.

The element can hold these values
  • ORIGINAL
  • TO_LOWER_CASE
  • TO_UPPER_CASE
optional
useFromChildCallsboolean

If true request attribute will be taken from a child service call.

Only applicable for the SERVICE_REQUEST_ATTRIBUTE attribute. Defaults to false.

optional
aggregationstring

Which value of the request attribute must be used when it occurs across multiple child requests.

Only applicable for the SERVICE_REQUEST_ATTRIBUTE attribute, when useFromChildCalls is true.

For the COUNT aggregation, the kind field is not applicable.

The element can hold these values
  • COUNT
  • FIRST
  • LAST
optional
sourcePropagationSource

Defines valid sources of request attributes for conditions or placeholders.

optional

The PropagationSource object

Defines valid sources of request attributes for conditions or placeholders.

ElementTypeDescriptionRequired
managementZonestring

Use only request attributes from services that belong to this management zone.. Use either this or serviceTag

optional
serviceTagUniversalTag

Use only request attributes from services that have this tag. Use either this or managementZone

optional

The UniversalTag object

Use only request attributes from services that have this tag. Use either this or managementZone

ElementTypeDescriptionRequired
tagKeyUniversalTagKey-optional
valuestring

The value of the tag. Not applicable to custom tags.

If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used.

optional
keystring

The key of the tag. For custom tags, put the tag value here.

The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags.

required
contextstring

The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.

The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, CONTEXTLESS set.

The element can hold these values
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_COMPUTE_ENGINE
  • KUBERNETES
optional

The UniversalTagKey object

ElementTypeDescriptionRequired
contextstring-
The element can hold these values
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_COMPUTE_ENGINE
  • KUBERNETES
optional
keystring-optional

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
{ "enabled": true, "namingPattern": "renamed request", "conditions": [ { "attribute": "WEBREQUEST_URL_PATH", "comparisonInfo": { "type": "STRING", "comparison": "BEGINS_WITH", "value": "/url", "negate": false, "caseSensitive": false } } ] }

Response

The request returns the short representation of the newly created rule.

Response codes

CodeTypeDescription
201EntityShortRepresentation

Success. The request naming has been created. Response contains the new service's ID.

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

json
{ "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.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestNaming/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestNaming/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/requestNaming/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

CodeTypeDescription
204

Validated. The submitted configuration is valid. Response does not have a body.

400ErrorEnvelope

Failed. The input is invalid.