Data privacy API - PUT configuration

Updates the global configuration of data privacy, affecting all your applications.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/dataPrivacy
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/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

Parameter
Type
Description
In
Required
body

Global configuration for data privacy and security.

body
required

Request body objects

The DataPrivacyAndSecurity object

Global configuration for data privacy and security.

Element
Type
Description
Required
logAuditEvents
boolean

The audit logging is enabled (true) or disabled (false).

optional
maskIpAddressesAndGpsCoordinates
boolean

Masking of IP addresses and GPS coordinates is enabled (true) or disabled (false).

required
maskPersonalDataInUris
boolean

Masking of personal data in URIs is enabled (true) or disabled (false).

required
maskUserActionNames
boolean

Masking of user action names is enabled (true) or disabled (false).

This masking is available only for web applications.

required
metadata

Metadata useful for debugging

optional

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
Required
clusterVersion
string

Dynatrace version.

optional
configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

optional

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.

{
  "logAuditEvents": true,
  "maskIpAddressesAndGpsCoordinates": true,
  "maskPersonalDataInUris": true,
  "maskUserActionNames": true,
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ]
  }
}

Response

Response codes

Code
Type
Description
204
-

Success. The configuration has 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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/dataPrivacy/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/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

Code
Type
Description
204
-

Success. The submitted configuration is valid. Response doesn't have a body.

400

Failed. The input is invalid.

Example

In this example, the request updates the data privacy configuration from the GET request example. It activates the Mask user actions and Mask personal data in URLs features.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own. First, be sure to create a backup copy of your current configuration with the GET data privacy configuration call.

Curl

curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/dataPrivacy \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{<truncated - see the Request body section below>}'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/dataPrivacy

Request body

{
  "maskIpAddressesAndGpsCoordinates": true,
  "maskUserActionNames": true,
  "maskPersonalDataInUris": true,
  "logAuditEvents": true
}

Response code

204

Related topics