Request attributes API - POST a request attribute

Creates a new request attribute.

The request consumes and produces an application/json payload.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestAttributes SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestAttributes

Authentication

To execute this request, you need the Capture request data (CaptureRequestData) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	RequestAttribute		body	optional

Request parameters JSON model

The RequestAttribute object

Element	Type	Description	Required
metadata	ConfigurationMetadata		optional
id	string	The ID of the request attribute.	optional
name	string	The name of the request attribute.	required
enabled	boolean	The request attribute is enabled (`true`) or disabled (`false`).	required
dataType	string	The data type of the request attribute. The dataType element can hold these values.	required
dataSources	DataSource[]	The list of data sources.	required
normalization	string	String values transformation. If the dataType is not `string`, set the `Original` here. The normalization element can hold these values.	required
aggregation	string	Aggregation type for the request values. The aggregation element can hold these values.	required
confidential	boolean	Confidential data flag. Set `true` to treat the captured data as confidential.	required
skipPersonalDataMasking	boolean	Personal data masking flag. Set `true` to skip masking. Warning: This will potentially access personalized data.	required

The DataSource object

Element	Type	Description	Required
enabled	boolean	The data source is enabled (`true`) or disabled (`false`).	required
source	string	The source of the attribute to capture. Works in conjunction with parameterName or methods and technology. The source element can hold these values.	required
valueProcessing	ValueProcessing		optional
technology	string	The technology of the method to capture if the source value is `METHOD_PARAM`. \n\n Not applicable in other cases. The technology element can hold these values.	optional
sessionAttributeTechnology	string	The technology of the session attribute to capture if the source value is `SESSION_ATTRIBUTE`. \n\n Not applicable in other cases. The sessionAttributeTechnology element can hold these values.	optional
methods	CapturedMethod[]	The method specification if the source value is `METHOD_PARAM`. Not applicable in other cases.	optional
parameterName	string	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.	optional
scope	ScopeConditions		optional
capturingAndStorageLocation	string	Specifies 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. The capturingAndStorageLocation element can hold these values.	optional
iibNodeType	string	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. The iibNodeType element can hold these values.	optional
iibMethodNodeCondition	ValueCondition		optional
cicsSDKMethodNodeCondition	ValueCondition		optional
iibLabelMethodNodeCondition	ValueCondition		optional

The ScopeConditions object

Conditions for data capturing.

Element	Type	Description	Required
serviceTechnology	string	Only applies to this service technology. The serviceTechnology element can hold these values.	optional
processGroup	string	Only applies to this process group. Note that this can't be transferred between different clusters or environments.	optional
hostGroup	string	Only applies to this host group.	optional
tagOfProcessGroup	string	Only apply to process groups matching this tag.	optional

The CapturedMethod object

Element	Type	Description	Required
method	MethodReference		required
capture	string	What to capture from the method. The capture element can hold these values.	required
argumentIndex	integer	The 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.	optional
deepObjectAccess	string	The 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.	optional

The MethodReference object

Configuration of a method to be captured.

Element	Type	Description	Required
visibility	string	The visibility of the method to capture. The visibility element can hold these values.	required
modifiers	string[]	The modifiers of the method to capture. The modifiers element can hold these values.	required
className	string	The class name where the method to capture resides. Either this or the fileName must be set.	optional
fileName	string	The file name where the method to capture resides. Either this or className must be set.	optional
fileNameMatcher	string	The operator of the comparison. If not set, `EQUALS` is used. The fileNameMatcher element can hold these values.	optional
methodName	string	The name of the method to capture.	required
argumentTypes	string[]	The list of argument types.	required
returnType	string	The return type.	required

The ValueProcessing object

Process values as specified.

Element	Type	Description	Required
valueCondition	ValueCondition		optional
valueExtractorRegex	string	Extract value from captured data per regex.	optional
splitAt	string	Split (preprocessed) string values at this separator.	optional
trim	boolean	Prune Whitespaces. Defaults to false.	required
extractSubstring	ExtractSubstring		optional

The ExtractSubstring object

Preprocess by extracting a substring from the original value.

Element Type Description Required

position

string

Element	Type	Description	Required
position	string	The position of the extracted string relative to delimiters. The position element can hold these values.	required
delimiter	string	The delimiter string.	required
endDelimiter	string	The end-delimiter string. Required if the position value is `BETWEEN`. Otherwise not allowed.	optional

The position of the extracted string relative to delimiters.

The position element can hold these values.

required

delimiter

string

The delimiter string.

required

endDelimiter

string

The end-delimiter string.

Required if the position value is BETWEEN. Otherwise not allowed.

optional

The ValueCondition object

IBM integration bus label node name condition for which the value is captured.

Element	Type	Description	Required
operator	string	Operator comparing the extracted value to the comparison value. The operator element can hold these values.	required
negate	boolean	Negate the comparison.	required
value	string	The value to compare to.	required

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description	Required
currentConfigurationVersions	string[]	A Sorted list of string version numbers of the configuration.	optional
clusterVersion	string	Dynatrace server version.	optional
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "name": "Query Term",
  "enabled": true,
  "dataType": "STRING",
  "dataSources": [
    {
      "enabled": true,
      "source": "QUERY_PARAMETER",
      "parameterName": "query",
      "scope": {
        "tagOfProcessGroup": "SearchFrontend"
      },
      "capturingAndStorageLocation": "CAPTURE_AND_STORE_ON_SERVER"
    }
  ],
  "normalization": "TO_LOWER_CASE",
  "aggregation": "ALL_DISTINCT_VALUES",
  "confidential": false,
  "skipPersonalDataMasking": false
}

Possible values

Possible values for the aggregation element in the RequestAttribute object:

ALL_DISTINCT_VALUES
AVERAGE
COUNT_DISTINCT_VALUES
COUNT_VALUES
FIRST
LAST
MAXIMUM
MINIMUM
SUM

Possible values for the normalization element in the RequestAttribute object:

ORIGINAL
TO_LOWER_CASE
TO_UPPER_CASE

Possible values for the iibNodeType element in the DataSource object:

AGGREGATE_CONTROL_NODE
AGGREGATE_REPLY_NODE
AGGREGATE_REQUEST_NODE
CALLABLE_FLOW_REPLY_NODE
COLLECTOR_NODE
COMPUTE_NODE
DATABASE_NODE
DECISION_SERVICE_NODE
DOT_NET_COMPUTE_NODE
FILE_READ_NODE
FILTER_NODE
FLOW_ORDER_NODE
GROUP_COMPLETE_NODE
GROUP_GATHER_NODE
GROUP_SCATTER_NODE
HTTP_HEADER
JAVA_COMPUTE_NODE
JMS_CLIENT_RECEIVE
JMS_CLIENT_REPLY_NODE
JMS_HEADER
MQ_GET_NODE
MQ_OUTPUT_NODE
PASSTHRU_NODE
RESET_CONTENT_DESCRIPTOR_NODE
RE_SEQUENCE_NODE
ROUTE_NODE
SAP_REPLY_NODE
SCA_REPLY_NODE
SECURITY_PEP
SEQUENCE_NODE
SOAP_EXTRACT_NODE
SOAP_REPLY_NODE
SOAP_WRAPPER_NODE
SR_RETRIEVE_ENTITY_NODE
SR_RETRIEVE_IT_SERVICE_NODE
THROW_NODE
TRACE_NODE
TRY_CATCH_NODE
VALIDATE_NODE
WS_REPLY_NODE
XSL_MQSI_NODE

Possible values for the capturingAndStorageLocation element in the DataSource object:

CAPTURE_AND_STORE_ON_BOTH
CAPTURE_AND_STORE_ON_CLIENT
CAPTURE_AND_STORE_ON_SERVER
CAPTURE_ON_CLIENT_STORE_ON_SERVER

Possible values for the serviceTechnology element in the ScopeConditions object:

ACTIVE_MQ
ACTIVE_MQ_ARTEMIS
ADO_NET
AIX
AKKA
AMAZON_REDSHIFT
AMQP
APACHE_CAMEL
APACHE_CASSANDRA
APACHE_COUCH_DB
APACHE_DERBY
APACHE_HTTP_CLIENT_ASYNC
APACHE_HTTP_CLIENT_SYNC
APACHE_HTTP_SERVER
APACHE_KAFKA
APACHE_SOLR
APACHE_STORM
APACHE_SYNAPSE
APACHE_TOMCAT
APPARMOR
APPLICATION_INSIGHTS_SDK
ASP_DOTNET
ASP_DOTNET_CORE
ASP_DOTNET_CORE_SIGNALR
ASP_DOTNET_SIGNALR
AWS_LAMBDA
AWS_RDS
AWS_SERVICE
AXIS
AZURE_FUNCTIONS
AZURE_SERVICE_BUS
AZURE_SERVICE_FABRIC
AZURE_STORAGE
BOSHBPM
CITRIX
CITRIX_COMMON
CITRIX_DESKTOP_DELIVERY_CONTROLLERS
CITRIX_DIRECTOR
CITRIX_LICENSE_SERVER
CITRIX_PROVISIONING_SERVICES
CITRIX_STOREFRONT
CITRIX_VIRTUAL_DELIVERY_AGENT
CITRIX_WORKSPACE_ENVIRONMENT_MANAGEMENT
CLOUDFOUNDRY
CLOUDFOUNDRY_AUCTIONEER
CLOUDFOUNDRY_BOSH
CLOUDFOUNDRY_GOROUTER
COLDFUSION
CONTAINERD
CORE_DNS
COUCHBASE
CRIO
CXF
DATASTAX
DB2
DIEGO_CELL
DOCKER
DOTNET
DOTNET_REMOTING
ELASTIC_SEARCH
ENVOY
ERLANG
ETCD
F5_LTM
FSHARP
GARDEN
GLASSFISH
GO
GRAAL_TRUFFLE
GRPC
GRSECURITY
HADOOP
HADOOP_HDFS
HADOOP_YARN
HAPROXY
HEAT
HESSIAN
HORNET_Q
IBM_CICS_REGION
IBM_CICS_TRANSACTION_GATEWAY
IBM_IMS_CONNECT_REGION
IBM_IMS_CONTROL_REGION
IBM_IMS_MESSAGE_PROCESSING_REGION
IBM_IMS_SOAP_GATEWAY
IBM_INTEGRATION_BUS
IBM_MQ
IBM_MQ_CLIENT
IBM_WEBSHPRERE_APPLICATION_SERVER
IBM_WEBSHPRERE_LIBERTY
IIS
IIS_APP_POOL
ISTIO
JAVA
JAX_WS
JBOSS
JBOSS_EAP
JDK_HTTP_SERVER
JERSEY
JETTY
JRUBY
JYTHON
KUBERNETES
LIBVIRT
LINKERD
MARIADB
MEMCACHED
MICROSOFT_SQL_SERVER
MONGODB
MSSQL_CLIENT
MULE_ESB
MYSQL
MYSQL_CONNECTOR
NETFLIX_SERVO
NETTY
NGINX
NODE_JS
OK_HTTP_CLIENT
ONEAGENT_SDK
OPENCENSUS
OPENSHIFT
OPENSTACK_COMPUTE
OPENSTACK_CONTROLLER
OPENTELEMETRY
OPENTRACING
OPEN_LIBERTY
ORACLE_DATABASE
ORACLE_WEBLOGIC
OWIN
PERL
PHP
PHP_FPM
PLAY
POSTGRE_SQL
POSTGRE_SQL_DOTNET_DATA_PROVIDER
POWER_DNS
PROGRESS
PYTHON
RABBIT_MQ
REDIS
RESTEASY
RESTLET
RIAK
RUBY
SAG_WEBMETHODS_IS
SAP
SAP_HANADB
SAP_HYBRIS
SAP_MAXDB
SAP_SYBASE
SCALA
SELINUX
SHAREPOINT
SPARK
SPRING
SQLITE
THRIFT
TIBCO
TIBCO_BUSINESS_WORKS
TIBCO_EMS
VARNISH_CACHE
VIM2
VIRTUAL_MACHINE_KVM
VIRTUAL_MACHINE_QEMU
WILDFLY
WINDOWS_CONTAINERS
WINK
ZERO_MQ

Possible values for the capture element in the CapturedMethod object:

ARGUMENT
CLASS_NAME
METHOD_NAME
OCCURRENCES
SIMPLE_CLASS_NAME
THIS

Possible values for the fileNameMatcher element in the MethodReference object:

ENDS_WITH
EQUALS
STARTS_WITH

Possible values for the modifiers element in the MethodReference object:

ABSTRACT
EXTERN
FINAL
NATIVE
STATIC

Possible values for the visibility element in the MethodReference object:

INTERNAL
PACKAGE_PROTECTED
PRIVATE
PROTECTED
PUBLIC

Possible values for the sessionAttributeTechnology element in the DataSource object:

ASP_NET
ASP_NET_CORE
JAVA

Possible values for the technology element in the DataSource object:

DOTNET
JAVA
PHP

Possible values for the position element in the ExtractSubstring object:

AFTER
BEFORE
BETWEEN

Possible values for the operator element in the ValueCondition object:

BEGINS_WITH
CONTAINS
ENDS_WITH
EQUALS

Possible values for the source element in the DataSource object:

CICS_SDK
CLIENT_IP
CUSTOM_ATTRIBUTE
IIB_LABEL
IIB_NODE
METHOD_PARAM
POST_PARAMETER
QUERY_PARAMETER
REQUEST_HEADER
RESPONSE_HEADER
SESSION_ATTRIBUTE
URI
URI_PATH

Possible values for the dataType element in the RequestAttribute object:

DOUBLE
INTEGER
STRING

Response format

Response parameters JSON model

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.

    
{
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity",
  "description": "Dynatrace entity for the REST API example\n"
}

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	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestAttributes/validator SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestAttributes/validator

Authentication

To execute this request, you need the Capture request data (CaptureRequestData) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response codes

Code	Description
204	Validated. The submitted configuration is valid. Response does not have a body.
400	Failed. The input is invalid.