Web application configuration API - PUT data privacy of the default application

Updates the data privacy parameters of the default web application of your Dynatrace environment.

The request consumes an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/default/dataPrivacy
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default/dataPrivacy


Parameter Type Description In Required
body ApplicationDataPrivacy

JSON body of the request, containing new data privacy settings.

body optional

The ApplicationDataPrivacy object

Data privacy settings of the application.

Element Type Description Required
metadata ConfigurationMetadata optional
identifier string

Dynatrace entity ID of the web application.

dataCaptureOptInEnabled boolean

Set to true to disable data capture and cookies until JavaScriptAPI dtrum.enable() is called.

persistentCookieForUserTracking boolean

Set to true to set persistent cookie in order to recognize returning devices.

doNotTrackBehaviour string

How to handle browsers' "Do Not Track": IGNORE_DO_NOT_TRACK, or CAPTURE_ANONYMIZED, or DO_NOT_CAPTURE.

The doNotTrackBehaviour element can hold these values.
sessionReplayConfig SessionReplaySetting optional

The SessionReplaySetting object

Session replay settings

Element Type Description Required
enabled boolean

SessionReplay Enabled.

costControlPercentage integer

Session replay sampling rating in percentage.


The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
clusterVersion string

Dynatrace server version.

configurationVersions integer[]

A Sorted list of the version numbers of the configuration.


Possible values

Possible values for the doNotTrackBehaviour element in the ApplicationDataPrivacy object:


Response format

A successful request doesn't return any content.

Response codes

Code Description
204 Success. Data privacy settings have been updated. Response doesn't have a body.
400 Failed. The input is invalid.

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.

The request consumes an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/default/dataPrivacy/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default/dataPrivacy/validator

Response codes

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