Patch Anon Settings

Patch Anon Settings

Change anonymization settings with the given values. To disable/enable only provided the disabled flag in the request body. To clear the redaction string, provide a null attribute in the request body. When you want to change a anonymization group, only set it in the settings array. The rest of the groups will be intact.

Request
URI
PATCH
https://{api_host}/anon-settings
COPY
Request Body

Change anonymization settings

AnonSettings of type(s) application/json
Required 
{
    "disabled": false,
    "settings": [
        {
            "group": "string",
            "description": "string",
            "enabled": false,
            "dataPath": [
                {
                    "stream": "string",
                    "who": "string",
                    "path": "string",
                    "description": "string",
                    "enabled": false
                }
            ]
        }
    ],
    "redactionString": "string"
}
boolean
disabled
Optional

True to disable anonymization. When false or undefined anonymization is enabled.

array of AnonGroup
settings
Optional

The list of configured anonymization groups.

string
redactionString
Optional

When set, anonymization is performed using the given string by replacing all enabled data path elements with it instead of hashing values.

Responses
202

Anonymization settings successfully patched.

Operation doesn't return any data structure

401
Returns 401Unauthorized_sessionID of type(s) application/json 
{
    "errCode": "GW_LOGIN_REQUIRED",
    "errMessage": "Your session not found or already expired. Please login"
}
string
errCode
Optional

errCode

string
errMessage
Optional

errMessage


On This Page
Anonymization Operations
POST
Deanonymize
GET
Get Anon Settings
PATCH
Patch Anon Settings