Updates the specified request attribute.
The request consumes and produces an application/json payload.
| PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestAttributes/{id} |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/requestAttributes/{id} |
To execute this request, you need an access token with CaptureRequestData scope.
To learn how to obtain and use it, see Tokens and authentication.
The ID of the request attribute to be updated.
If you set the ID in the body as well, it must match this ID.
RequestAttribute objectAggregation type for the request values.
ALL_DISTINCT_VALUESAVERAGECOUNT_DISTINCT_VALUESCOUNT_VALUESFIRSTLASTMAXIMUMMINIMUMSUMConfidential data flag. Set true to treat the captured data as confidential.
The data type of the request attribute.
DOUBLEINTEGERSTRINGThe request attribute is enabled (true) or disabled (false).
The ID of the request attribute.
The name of the request attribute.
String values transformation.
If the dataType is not string, set the Original here.
ORIGINALTO_LOWER_CASETO_UPPER_CASEPersonal data masking flag. Set true to skip masking.
Warning: This will potentially access personalized data.
DataSource objectSpecifies the location where the values are captured and stored.
Required if the source is one of the following: GET_PARAMETER, URI, REQUEST_HEADER, RESPONSE_HEADER.
Not applicable in other cases.
If the source value is REQUEST_HEADER or RESPONSE_HEADER, the CAPTURE_AND_STORE_ON_BOTH location is not allowed.
CAPTURE_AND_STORE_ON_BOTHCAPTURE_AND_STORE_ON_CLIENTCAPTURE_AND_STORE_ON_SERVERCAPTURE_ON_CLIENT_STORE_ON_SERVERIBM integration bus label node name condition for which the value is captured.
CICS transaction call type condition for which the value is captured.
Required if the source is: CICS_TRANSACTION_CALL_TYPE.
Not applicable in other cases.
CTGDPLEXPLICIT_ADKHTTPIMS_CONNECTIMS_CONNECT_APIIMS_ITRAIMS_MSCIMS_PGM_SWITCHIMS_SHARED_QUEUESIMS_TRANS_EXECMQSOAPSTARTTTXTXUNKNOWNZOS_CONNECTThe data source is enabled (true) or disabled (false).
IBM integration bus label node name condition for which the value is captured.
IBM integration bus label node name condition for which the value is captured.
The IBM integration bus node type for which the value is captured.
This or iibMethodNodeCondition is required if the source is: IIB_NODE.
Not applicable in other cases.
AGGREGATE_CONTROL_NODEAGGREGATE_REPLY_NODEAGGREGATE_REQUEST_NODECALLABLE_FLOW_REPLY_NODECOLLECTOR_NODECOMPUTE_NODEDATABASE_NODEDATABASE_RETRIEVE_NODEDATABASE_ROUTE_NODEDECISION_SERVICE_NODEDOT_NET_COMPUTE_NODEFILE_READ_NODEFILTER_NODEFLOW_ORDER_NODEGROUP_COMPLETE_NODEGROUP_GATHER_NODEGROUP_SCATTER_NODEHTTP_ASYNC_REQUESTHTTP_ASYNC_RESPONSEHTTP_HEADERHTTP_INPUTHTTP_REPLYHTTP_REQUESTJAVA_COMPUTE_NODEJMS_CLIENT_RECEIVEJMS_CLIENT_REPLY_NODEJMS_HEADERJMS_INPUT_NODEJMS_OUTPUT_NODEJMS_REPLY_NODEMQ_GET_NODEMQ_INPUT_NODEMQ_OUTPUT_NODEMQ_REPLY_NODEPASSTHRU_NODEPUBLICATION_NODERESET_CONTENT_DESCRIPTOR_NODEREST_ASYNC_REQUEST_NODEREST_ASYNC_RESPONSE_NODEREST_REQUEST_NODERE_SEQUENCE_NODEROUTE_NODESAP_REPLY_NODESCA_REPLY_NODESECURITY_PEPSEQUENCE_NODESOAP_ASYNC_REQUEST_NODESOAP_ASYNC_RESPONSE_NODESOAP_EXTRACT_NODESOAP_INPUT_NODESOAP_REPLY_NODESOAP_REQUEST_NODESOAP_WRAPPER_NODESR_RETRIEVE_ENTITY_NODESR_RETRIEVE_IT_SERVICE_NODETHROW_NODETRACE_NODETRY_CATCH_NODEVALIDATE_NODEWS_REPLY_NODEXSL_MQSI_NODEIMS transaction call type condition for which the value is captured.
Required if the source is: IMS_TRANSACTION_CALL_TYPE.
Not applicable in other cases.
CTGDPLEXPLICIT_ADKHTTPIMS_CONNECTIMS_CONNECT_APIIMS_ITRAIMS_MSCIMS_PGM_SWITCHIMS_SHARED_QUEUESIMS_TRANS_EXECMQSOAPSTARTTTXTXUNKNOWNZOS_CONNECTThe method specification if the source value is METHOD_PARAM.
Not applicable in other cases.
The name of the web request parameter to capture.
Required if the source is one of the following: POST_PARAMETER, GET_PARAMETER, REQUEST_HEADER, RESPONSE_HEADER, CUSTOM_ATTRIBUTE.
Not applicable in other cases.
The technology of the server variable to capture if the source value is SERVER_VARIABLE. \n\n Not applicable in other cases.
ASP_NETThe technology of the session attribute to capture if the source value is SESSION_ATTRIBUTE. \n\n Not applicable in other cases.
ASP_NETASP_NET_COREJAVAPHPThe source of the attribute to capture. Works in conjunction with parameterName or methods and technology.
CICS_PATH_NAMECICS_SDKCICS_SYSTEM_IDCICS_TASK_IDCICS_TRANSACTION_CALL_TYPECICS_TRANSACTION_GROUP_IDCICS_UNIT_OF_WORK_IDCICS_USER_IDCLIENT_IPCUSTOM_ATTRIBUTEDLI_DB_OR_LTERM_NAMEDLI_SEGMENT_NAMEIIB_LABELIIB_NODEIMS_TRANSACTION_CALL_TYPEIMS_UNIT_OF_WORK_IDIMS_USER_IDMETHOD_PARAMMQ_CORRELATION_IDMQ_MESSAGE_IDMQ_MESSAGE_SIZEPOST_PARAMETERQUERY_PARAMETERREQUEST_HEADERRESPONSE_HEADERSERVER_VARIABLESESSION_ATTRIBUTESPAN_ATTRIBUTEURIURI_PATHWEBSERVICE_METHODWEBSERVICE_NAMEThe key of the span attribute to capture.
Required if the source is: SPAN_ATTRIBUTE.
Not applicable in other cases.
The technology of the method to capture if the source value is METHOD_PARAM. \n\n Not applicable in other cases.
DOTNETJAVAPHPValueCondition objectIBM integration bus label node name condition for which the value is captured.
Negate the comparison.
Operator comparing the extracted value to the comparison value.
BEGINS_WITHBEGINS_WITH_ANY_OFCONTAINSENDS_WITHENDS_WITH_ANY_OFEQUALSEQUALS_ANY_OFThe value to compare to.
CapturedMethod objectThe index of the argument to capture. Set 0 to capture the return value, 1 or higher to capture a mehtod argument.
Required if the capture is set to ARGUMENT.
Not applicable in other cases.
What to capture from the method.
ARGUMENTCLASS_NAMEMETHOD_NAMEOCCURRENCESSIMPLE_CLASS_NAMETHISThe getter chain to apply to the captured object. It is required in one of the following cases:
The capture is set to THIS.
The capture is set to ARGUMENT, and the argument is not a primitive, a primitive wrapper class, a string, or an array.
Not applicable in other cases.
MethodReference objectConfiguration of a method to be captured.
The list of argument types.
The class name where the method to capture resides.
Either this or the fileName must be set.
The file name where the method to capture resides.
Either this or className must be set.
The operator of the comparison.
If not set, EQUALS is used.
ENDS_WITHEQUALSSTARTS_WITHThe name of the method to capture.
The modifiers of the method to capture.
ABSTRACTEXTERNFINALNATIVESTATICThe return type.
The visibility of the method to capture.
INTERNALPACKAGE_PROTECTEDPRIVATEPROTECTEDPUBLICScopeConditions objectConditions for data capturing.
Only applies to this host group.
Only applies to this process group. Note that this can't be transferred between different clusters or environments.
Only applies to this service technology.
ACTIVEMQ_CLIENTACTIVE_MQACTIVE_MQ_ARTEMISADOBE_EXPERIENCE_MANAGERADO_NETAIXAKKAAMAZON_REDSHIFTAMQPAPACHE_CAMELAPACHE_CASSANDRAAPACHE_COUCH_DBAPACHE_DERBYAPACHE_HTTP_CLIENT_ASYNCAPACHE_HTTP_CLIENT_SYNCAPACHE_HTTP_SERVERAPACHE_KAFKAAPACHE_LOG4JAPACHE_SOLRAPACHE_STORMAPACHE_SYNAPSEAPACHE_TOMCATAPPARMORAPPLICATION_INSIGHTS_SDKASP_DOTNETASP_DOTNET_COREASP_DOTNET_CORE_SIGNALRASP_DOTNET_SIGNALRASYNC_HTTP_CLIENTAWS_DYNAMO_DBAWS_EVENT_BRIDGEAWS_LAMBDAAWS_RDSAWS_SERVICEAWS_SNS_CLIENTAWS_SQSAXISAZURE_FUNCTIONSAZURE_SERVICE_BUSAZURE_SERVICE_FABRICAZURE_STORAGEBOSHBPMCICS_FILE_ACCESSCITRIXCITRIX_COMMONCITRIX_DESKTOP_DELIVERY_CONTROLLERSCITRIX_DIRECTORCITRIX_LICENSE_SERVERCITRIX_PROVISIONING_SERVICESCITRIX_STOREFRONTCITRIX_VIRTUAL_DELIVERY_AGENTCITRIX_WORKSPACE_ENVIRONMENT_MANAGEMENTCITRIX_XENCLOUDFOUNDRYCLOUDFOUNDRY_AUCTIONEERCLOUDFOUNDRY_BOSHCLOUDFOUNDRY_GOROUTERCLRCODEIGNITERCOLDFUSIONCONFLUENT_KAFKA_CLIENTCONTAINERDCORE_DNSCOSMOSDBCOUCHBASECRIOCXFDATASTAXDB2DIEGO_CELLDOCKERDOTNETDOTNET_REMOTINGDRUPALDYNATRACEELASTIC_SEARCHENVOYERLANGETCDF5_LTMFSHARPGARDENGLASSFISHGOGOOGLE_CLOUD_FUNCTIONSGRAAL_NATIVE_IMAGEGRAAL_TRUFFLEGRAPH_QLGRPCGRSECURITYHADOOPHADOOP_HDFSHADOOP_YARNHAPROXYHEATHELIDONHESSIANHORNET_QIBM_CICS_REGIONIBM_CICS_TRANSACTION_GATEWAYIBM_IMS_CONNECT_REGIONIBM_IMS_CONTROL_REGIONIBM_IMS_MESSAGE_PROCESSING_REGIONIBM_IMS_SOAP_GATEWAYIBM_INTEGRATION_BUSIBM_MQIBM_MQ_CLIENTIBM_WEBSHPRERE_APPLICATION_SERVERIBM_WEBSHPRERE_LIBERTYIBM_WEBSPHERE_APPLICATION_SERVERIBM_WEBSPHERE_LIBERTYIISIIS_APP_POOLISTIOJAVAJAVA_HTTPURLCONNECTIONJAVA_HTTPURLCONNETIONJAX_WSJBOSSJBOSS_EAPJBOSS_LOGMANAGERJDK_HTTP_CLIENTJDK_HTTP_SERVERJERSEYJETTYJOOMLAJRUBYJYTHONKUBERNETESLAMINASLARAVELLIBCLIBVIRTLINKERDLINUX_SYSTEMLOGSTASH_LOGBACK_ENCODERMAGENTOMARIADBMEMCACHEDMICRONAUTMICROSOFT_SQL_SERVERMONGODBMONGODB_CLIENTMONGODB_CLIENT_DOTNETMSSQL_CLIENTMULE_ESBMYSQLMYSQL_CONNECTORNETFLIX_SERVONETTYNGINXNODE_JSOK_HTTP_CLIENTONEAGENT_SDKOPENCENSUSOPENSHIFTOPENSTACK_COMPUTEOPENSTACK_CONTROLLEROPENTELEMETRYOPENTRACINGOPEN_LIBERTYORACLE_DATABASEORACLE_DB_LISTENERORACLE_WEBLOGICOWINOWIN_KATANAPERLPHPPHP_FPMPLAYPODMANPOSTGRE_SQLPOSTGRE_SQL_DOTNET_DATA_PROVIDERPOWER_DNSPROGRESSPYTHONQOS_LOGBACKQUARKUSRABBITMQ_CLIENTRABBIT_MQREACTOR_COREREDISRESTEASYRESTLETRIAKRKE2RSOCKETRUBYRUNCRXJAVASAG_WEBMETHODS_ISSAPSAP_HANADBSAP_HYBRISSAP_MAXDBSAP_SYBASESCALASECURITY_SOFTWARESELINUXSHAREPOINTSHELLSLIMSPARKSPRINGSQLITESYMFONYTHRIFTTIBCOTIBCO_BUSINESS_WORKSTIBCO_EMSUNDERTOW_IOVARNISH_CACHEVERTXVIM2VIOSVIRTUAL_MACHINE_KVMVIRTUAL_MACHINE_QEMUWCFWILDFLYWINDOWS_CONTAINERSWINDOWS_SYSTEMWINKWORDPRESSZERO_MQZOS_CONNECTOnly apply to process groups matching this tag.
ValueProcessing objectProcess values as specified.
Preprocess by extracting a substring from the original value.
Split (preprocessed) string values at this separator.
Prune Whitespaces. Defaults to false.
IBM integration bus label node name condition for which the value is captured.
Extract value from captured data per regex.
ExtractSubstring objectPreprocess by extracting a substring from the original value.
The delimiter string.
The end-delimiter string.
Required if the position value is BETWEEN. Otherwise not allowed.
The position of the extracted string relative to delimiters.
AFTERBEFOREBETWEENConfigurationMetadata objectMetadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"aggregation": "ALL_DISTINCT_VALUES","confidential": false,"dataSources": [{"capturingAndStorageLocation": "CAPTURE_AND_STORE_ON_SERVER","enabled": true,"parameterName": "query","scope": {"tagOfProcessGroup": "SearchFrontend"},"source": "QUERY_PARAMETER"}],"dataType": "STRING","enabled": true,"name": "Query Term","normalization": "TO_LOWER_CASE","skipPersonalDataMasking": false}
Success. The request attribute with the specified ID has been created. The ID of the new configuration is returned.
Success. Request attribute has been updated. Response doesn't have a body.
EntityShortRepresentation objectThe 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.
{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}
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/requestAttributes/{id}/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/requestAttributes/{id}/validator |
To execute this request, you need an access token with CaptureRequestData scope.
To learn how to obtain and use it, see Tokens and authentication.
Validated. The submitted configuration is valid. Response does not have a body.