Data privacy API - GET configuration

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

The request produces an application/json payload.

GETSaaShttps://{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 ReadConfig scope.

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

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

Code
Type
Description
200

Success

Response body objects

The DataPrivacyAndSecurity object

Global configuration for data privacy and security.

Element
Type
Description
logAuditEvents
boolean

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

maskIpAddressesAndGpsCoordinates
boolean

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

maskPersonalDataInUris
boolean

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

maskUserActionNames
boolean

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

This masking is available only for web applications.

metadata

Metadata useful for debugging

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
clusterVersion
string

Dynatrace version.

configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

Response body JSON model

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

Example

In this example, the request fetches the current data privacy configuration.

The API token is passed in the Authorization header.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/dataPrivacy \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

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

Response body

{
  "metadata": {
    "configurationVersions": [
      17,
      17
      ],
      "clusterVersion": "1.211.2.20210129-043235"
    },
    "maskIpAddressesAndGpsCoordinates": true,
    "maskUserActionNames": false,
    "maskPersonalDataInUris": false,
    "logAuditEvents": true
}

Related topics