Updates data privacy parameters of the specified web application.
This API only supports web applications. For mobile and custom applications, see Mobile and custom app API.
The request consumes and produces an application/json payload.
| PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}/dataPrivacy |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/{id}/dataPrivacy |
To execute this request, you need an access token with DataPrivacy scope.
To learn how to obtain and use it, see Tokens and authentication.
The ID of the web application, where you want to update data privacy settings.
JSON body of the request, containing new data privacy settings.
ApplicationDataPrivacy objectData privacy settings of the application.
Set to true to disable data capture and cookies until JavaScriptAPI dtrum.enable() is called.
How to handle the "Do Not Track" header:
IGNORE_DO_NOT_TRACK: ignore the header and capture the data.CAPTURE_ANONYMIZED: capture the data but do not tie it to the user.DO_NOT_CAPTURE: respect the header and do not capture.CAPTURE_ANONYMIZEDDO_NOT_CAPTUREIGNORE_DO_NOT_TRACKDynatrace entity ID of the web application.
Set to true to set persistent cookie in order to recognize returning devices.
Data privacy settings for Session Replay.
ConfigurationMetadata 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.
SessionReplayDataPrivacySettings objectData privacy settings for Session Replay.
Content masking settings for Session Replay.
For more details, see Configure Session Replay in Dynatrace Documentation.
If true, session recording is disabled until JavaScriptAPI dtrum.enableSessionReplay() is called.
A list of URLs to be excluded from recording.
SessionReplayContentMaskingSettings objectContent masking settings for Session Replay.
For more details, see Configure Session Replay in Dynatrace Documentation.
Configuration of the Session Replay masking.
Configuration of the Session Replay masking.
The version of the content masking.
You can use this API only with the version 2.
If you're using version 1, set this field to 2 in the PUT request to switch to version 2.
SessionReplayMaskingSetting objectConfiguration of the Session Replay masking.
The type of the masking:
MASK_ALL: Mask all texts, user input, and images.MASK_USER_INPUT: Mask all data that is provided through user inputALLOW_LIST: Only elements, specified in maskingRules are shown, everything else is masked.BLOCK_LIST: Elements, specified in maskingRules are masked, everything else is shown.ALLOW_LISTBLOCK_LISTMASK_ALLMASK_USER_INPUTMaskingRule objectThe masking rule defining how data is hidden.
The type of the masking rule.
ATTRIBUTEELEMENTThe selector for the element or the attribute to be masked.
Specify a CSS expression for an element or a regular expression for an attribute.
Interactions with the element are (true) or are not (`false) masked.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"dataCaptureOptInEnabled": true,"doNotTrackBehaviour": "CAPTURE_ANONYMIZED","identifier": "string","metadata": {"clusterVersion": "1.192.1","configurationVersions": [4,2],"currentConfigurationVersions": ["1.0.4","1.23"]},"persistentCookieForUserTracking": true,"sessionReplayDataPrivacy": {"contentMaskingSettings": {"playbackMaskingSettings": {"maskingPreset": "ALLOW_LIST","maskingRules": [{"maskingRuleType": "ATTRIBUTE","selector": "string","userInteractionHidden": false}]},"recordingMaskingSettings": {},"recordingMaskingSettingsVersion": 2},"optInModeEnabled": true,"urlExclusionRules": ["string"]}}
Success. Data privacy settings have been updated. Response doesn't have a body.
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/applications/web/{id}/dataPrivacy/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/{id}/dataPrivacy/validator |
To execute this request, you need an access token with DataPrivacy 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.