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

  • Reference
  • Published Sep 03, 2019

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

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default/dataPrivacy
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/default/dataPrivacy

Authentication

To execute this request, you need an access token with DataPrivacy scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodyApplicationDataPrivacy

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

bodyoptional

Request body objects

The ApplicationDataPrivacy object

Data privacy settings of the application.

ElementTypeDescriptionRequired
dataCaptureOptInEnabledboolean

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

required
doNotTrackBehaviourstring

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_ANONYMIZED
  • DO_NOT_CAPTURE
  • IGNORE_DO_NOT_TRACK
required
identifierstring

Dynatrace entity ID of the web application.

optional
metadataConfigurationMetadata

Metadata useful for debugging

optional
persistentCookieForUserTrackingboolean

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

required
sessionReplayDataPrivacySessionReplayDataPrivacySettings

Data privacy settings for Session Replay.

optional

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
clusterVersionstring

Dynatrace version.

optional
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional

The SessionReplayDataPrivacySettings object

Data privacy settings for Session Replay.

ElementTypeDescriptionRequired
contentMaskingSettingsSessionReplayContentMaskingSettings

Content masking settings for Session Replay.

For more details, see Configure Session Replay in Dynatrace Documentation.

optional
optInModeEnabledboolean

If true, session recording is disabled until JavaScriptAPI dtrum.enableSessionReplay() is called.

optional
urlExclusionRulesstring[]

A list of URLs to be excluded from recording.

optional

The SessionReplayContentMaskingSettings object

Content masking settings for Session Replay.

For more details, see Configure Session Replay in Dynatrace Documentation.

ElementTypeDescriptionRequired
playbackMaskingSettingsSessionReplayMaskingSetting

Configuration of the Session Replay masking.

optional
recordingMaskingSettingsSessionReplayMaskingSetting

Configuration of the Session Replay masking.

optional
recordingMaskingSettingsVersioninteger

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.

required

The SessionReplayMaskingSetting object

Configuration of the Session Replay masking.

ElementTypeDescriptionRequired
maskingPresetstring

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 input
  • ALLOW_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_LIST
  • BLOCK_LIST
  • MASK_ALL
  • MASK_USER_INPUT
required
maskingRulesMaskingRule[]

A list of masking rules.

optional

The MaskingRule object

The masking rule defining how data is hidden.

ElementTypeDescriptionRequired
maskingRuleTypestring

The type of the masking rule.

  • ATTRIBUTE
  • ELEMENT
required
selectorstring

The selector for the element or the attribute to be masked.

Specify a CSS expression for an element or a regular expression for an attribute.

required
userInteractionHiddenboolean

Interactions with the element are (true) or are not (`false) masked.

required

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.

{
  "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"
    ]
  }
}

Response

Response codes

CodeTypeDescription
204-

Success. Data privacy settings have been updated. Response doesn't have a body.

400ErrorEnvelope

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default/dataPrivacy/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/default/dataPrivacy/validator

Authentication

To execute this request, you need an access token with DataPrivacy scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204-

Validated. The submitted configuration is valid. Response does not have a body.

400ErrorEnvelope

Failed. The input is invalid.