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.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestNaming |
| Environment ActiveGate | https://{your-activegate-domain}:9999/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.
Order of the new request naming rule. Set to PREPEND to prepend it to the list, APPEND to append it. Defaults to APPEND.
APPENDPREPEND
The JSON body of the request containing parameters of the new request naming rule.
You must not specify the ID of the rule!
Request body objects
The RequestNaming object
The request naming rule.
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.
The rule is enabled (true) or disabled (false).
The ID of the request naming rule.
Specifies the management zones for which this rule should be applied.
The name to be assigned to matching requests.
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.
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.
The Condition object
A condition of a rule usage.
The attribute to be matched.
Note that for a service property attribute you must use the comparison of the FAST_STRING type.
ACTOR_SYSTEMAKKA_ACTOR_CLASS_NAMEAKKA_ACTOR_MESSAGE_TYPEAKKA_ACTOR_PATHAPPLICATION_BUILD_VERSIONAPPLICATION_ENVIRONMENTAPPLICATION_NAMEAPPLICATION_RELEASE_VERSIONAZURE_FUNCTIONS_FUNCTION_NAMEAZURE_FUNCTIONS_SITE_NAMECICS_PROGRAM_NAMECICS_SYSTEM_IDCICS_TASK_IDCICS_TRANSACTION_IDCICS_USER_IDCPU_TIMECTG_GATEWAY_URLCTG_PROGRAMCTG_SERVER_NAMECTG_TRANSACTION_IDCUSTOMSERVICE_CLASSCUSTOMSERVICE_METHODDATABASE_CHILD_CALL_COUNTDATABASE_CHILD_CALL_TIMEDATABASE_HOSTDATABASE_NAMEDATABASE_STATEMENTDATABASE_TYPEDATABASE_URLDISK_IO_TIMEERROR_COUNTESB_APPLICATION_NAMEESB_INPUT_TYPEESB_LIBRARY_NAMEESB_MESSAGE_FLOW_NAMEEXCEPTION_CLASSEXCEPTION_MESSAGEFAILED_STATEFAILURE_REASONFLAW_STATEHTTP_REQUEST_METHODHTTP_STATUSHTTP_STATUS_CLASSIMS_PROGRAM_NAMEIMS_TRANSACTION_IDIMS_USER_IDIO_TIMEIS_KEY_REQUESTLAMBDA_COLDSTARTLOCK_TIMEMESSAGING_DESTINATION_TYPEMESSAGING_IS_TEMPORARY_QUEUEMESSAGING_QUEUE_NAMEMESSAGING_QUEUE_VENDORNETWORK_IO_TIMENON_DATABASE_CHILD_CALL_COUNTNON_DATABASE_CHILD_CALL_TIMEPROCESS_GROUP_NAMEPROCESS_GROUP_TAGREMOTE_ENDPOINTREMOTE_METHODREMOTE_SERVICE_NAMEREQUEST_NAMEREQUEST_TYPERESPONSE_TIMERESPONSE_TIME_CLIENTRMI_CLASSRMI_METHODSERVICE_DISPLAY_NAMESERVICE_NAMESERVICE_PORTSERVICE_PUBLIC_DOMAIN_NAMESERVICE_REQUEST_ATTRIBUTESERVICE_TAGSERVICE_TYPESERVICE_WEB_APPLICATION_IDSERVICE_WEB_CONTEXT_ROOTSERVICE_WEB_SERVER_NAMESERVICE_WEB_SERVICE_NAMESERVICE_WEB_SERVICE_NAMESPACESUSPENSION_TIMETOTAL_PROCESSING_TIMEWAIT_TIMEWEBREQUEST_QUERYWEBREQUEST_RELATIVE_URLWEBREQUEST_URLWEBREQUEST_URL_HOSTWEBREQUEST_URL_PATHWEBREQUEST_URL_PORTWEBSERVICE_ENDPOINTWEBSERVICE_METHODZOS_CALL_TYPE
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.
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.
Operator of the comparision. You can reverse it by setting negate to true.
Reverse the comparison operator. For example, it turns equals into does not equal.
Defines the actual set of fields depending on the value. See one of the following objects:
STRING-> StringComparisonInfoNUMBER-> NumberComparisonInfoBOOLEAN-> BooleanComparisonInfoHTTP_METHOD-> HttpMethodComparisonInfoSTRING_REQUEST_ATTRIBUTE-> StringRequestAttributeComparisonInfoNUMBER_REQUEST_ATTRIBUTE-> NumberRequestAttributeComparisonInfoZOS_CALL_TYPE-> ZosComparisonInfoIIB_INPUT_NODE_TYPE-> IIBInputNodeTypeComparisonInfoESB_INPUT_NODE_TYPE-> ESBInputNodeTypeComparisonInfoFAILED_STATE-> FailedStateComparisonInfoFLAW_STATE-> FlawStateComparisonInfoFAILURE_REASON-> FailureReasonComparisonInfoHTTP_STATUS_CLASS-> HttpStatusClassComparisonInfoTAG-> TagComparisonInfoFAST_STRING-> FastStringComparisonInfoSERVICE_TYPE-> ServiceTypeComparisonInfo
BOOLEANESB_INPUT_NODE_TYPEFAILED_STATEFAILURE_REASONFAST_STRINGFLAW_STATEHTTP_METHODHTTP_STATUS_CLASSIIB_INPUT_NODE_TYPENUMBERNUMBER_REQUEST_ATTRIBUTESERVICE_TYPESTRINGSTRING_REQUEST_ATTRIBUTETAGZOS_CALL_TYPE
The value to compare to.
The values to compare to.
The AnyValue object
A schema representing an arbitrary value type.
The ConfigurationMetadata object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
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.
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.
COUNTFIRSTLAST
The attribute to extract from. You can only use attributes of the string type.
ACTOR_SYSTEMAKKA_ACTOR_CLASS_NAMEAKKA_ACTOR_MESSAGE_TYPEAKKA_ACTOR_PATHAPPLICATION_BUILD_VERSIONAPPLICATION_ENVIRONMENTAPPLICATION_NAMEAPPLICATION_RELEASE_VERSIONAZURE_FUNCTIONS_FUNCTION_NAMEAZURE_FUNCTIONS_SITE_NAMECICS_PROGRAM_NAMECICS_SYSTEM_IDCICS_TASK_IDCICS_TRANSACTION_IDCICS_USER_IDCPU_TIMECTG_GATEWAY_URLCTG_PROGRAMCTG_SERVER_NAMECTG_TRANSACTION_IDCUSTOMSERVICE_CLASSCUSTOMSERVICE_METHODDATABASE_CHILD_CALL_COUNTDATABASE_CHILD_CALL_TIMEDATABASE_HOSTDATABASE_NAMEDATABASE_STATEMENTDATABASE_TYPEDATABASE_URLDISK_IO_TIMEERROR_COUNTESB_APPLICATION_NAMEESB_INPUT_TYPEESB_LIBRARY_NAMEESB_MESSAGE_FLOW_NAMEEXCEPTION_CLASSEXCEPTION_MESSAGEFAILED_STATEFAILURE_REASONFLAW_STATEHTTP_REQUEST_METHODHTTP_STATUSHTTP_STATUS_CLASSIMS_PROGRAM_NAMEIMS_TRANSACTION_IDIMS_USER_IDIO_TIMEIS_KEY_REQUESTLAMBDA_COLDSTARTLOCK_TIMEMESSAGING_DESTINATION_TYPEMESSAGING_IS_TEMPORARY_QUEUEMESSAGING_QUEUE_NAMEMESSAGING_QUEUE_VENDORNETWORK_IO_TIMENON_DATABASE_CHILD_CALL_COUNTNON_DATABASE_CHILD_CALL_TIMEPROCESS_GROUP_NAMEPROCESS_GROUP_TAGREMOTE_ENDPOINTREMOTE_METHODREMOTE_SERVICE_NAMEREQUEST_NAMEREQUEST_TYPERESPONSE_TIMERESPONSE_TIME_CLIENTRMI_CLASSRMI_METHODSERVICE_DISPLAY_NAMESERVICE_NAMESERVICE_PORTSERVICE_PUBLIC_DOMAIN_NAMESERVICE_REQUEST_ATTRIBUTESERVICE_TAGSERVICE_TYPESERVICE_WEB_APPLICATION_IDSERVICE_WEB_CONTEXT_ROOTSERVICE_WEB_SERVER_NAMESERVICE_WEB_SERVICE_NAMESERVICE_WEB_SERVICE_NAMESPACESUSPENSION_TIMETOTAL_PROCESSING_TIMEWAIT_TIMEWEBREQUEST_QUERYWEBREQUEST_RELATIVE_URLWEBREQUEST_URLWEBREQUEST_URL_HOSTWEBREQUEST_URL_PATHWEBREQUEST_URL_PORTWEBSERVICE_ENDPOINTWEBSERVICE_METHODZOS_CALL_TYPE
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.
The closing delimiter string to look for.
Required if the kind value is BETWEEN_DELIMITER. Not applicable otherwise.
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
AFTER_DELIMITERBEFORE_DELIMITERBETWEEN_DELIMITERORIGINAL_TEXTREGEX_EXTRACTION
The name of the placeholder. Use it in the naming pattern as {name}.
The format of the extracted string.
ORIGINALTO_LOWER_CASETO_UPPER_CASE
The request attribute to extract from.
Required if the kind value is SERVICE_REQUEST_ATTRIBUTE. Not applicable otherwise.
Defines valid sources of request attributes for conditions or placeholders.
If true request attribute will be taken from a child service call.
Only applicable for the SERVICE_REQUEST_ATTRIBUTE attribute. Defaults to false.
The PropagationSource object
Defines valid sources of request attributes for conditions or placeholders.
Use only request attributes from services that belong to this management zone.. Use either this or serviceTag
Use only request attributes from services that have this tag. Use either this or managementZone
The UniversalTag object
Use only request attributes from services that have this tag. Use either this or managementZone
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.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
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.
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.
The UniversalTagKey object
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
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.
{"conditions": [{"attribute": "WEBREQUEST_URL_PATH","comparisonInfo": {"caseSensitive": false,"comparison": "BEGINS_WITH","negate": false,"type": "STRING","value": "/url"}}],"enabled": true,"namingPattern": "renamed request"}
Response
The request returns the short representation of the newly created rule.
Response codes
Success. The request naming has been created. Response contains the new service's ID.
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
Response body JSON model
{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}
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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestNaming/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/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
Validated. The submitted configuration is valid. Response does not have a body.