Data privacy API - PUT configuration
Updates the global configuration of data privacy, affecting all your applications.
The request consumes an application/json payload.
| PUT |
|
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | DataPrivacy | body | optional |
The DataPrivacy object
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | ConfigurationMetadata |
Metadata useful for debugging. |
optional |
| maskIpAddressesAndGpsCoordinates | boolean |
Mask IP addresses and GPS coordinates enabled/disabled. |
required |
| maskUserActionNames | boolean |
Mask user action names (Web applications only) enabled/disabled. |
required |
| maskPersonalDataInUris | boolean |
Mask personal data in URIs enabled/disabled. |
required |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| configurationVersions | integer[] |
A Sorted list of the version numbers of the configuration. |
optional |
| clusterVersion | string |
DESK server version. |
optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"metadata": {
"configurationVersions": [
"integer"
],
"clusterVersion": "string"
},
"maskIpAddressesAndGpsCoordinates": true,
"maskUserActionNames": true,
"maskPersonalDataInUris": true
}
Response format
A successful request doesn't return any content.
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.
| POST |
|
Response codes
| Code | Description |
|---|---|
| 204 | Validated. The submitted configuration is valid. Response does not have a body. |
| 400 | Failed. The input is invalid. See the response body for details. |