The privacySetStatus Web API Method

Update privacy settings.

Version: 1.14

Required Permissions:Full

HTTP method: POST

Supported by Editions: All

Request Parameters:

Parameter

 Type

Required

Description

enable_data_masking

boolean

Yes

Whether data should be masked.

zend_privacy_regex

String

Yes  
zend_privacy_functions

String

Yes  

zend_privacy_keys

String

Yes

 

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: boolean

Possible Action Specific Error Codes: None

Example

Usage Example

Request (headers removed for clarity)

POST /ZendServer/Api/privacySetStatus

enable_data_masking=true&zend_privacy_regex=""&zend_privacy_functions&zend_privacy_keys=""

Response

{ "success": 1 }

Important Note:

For Zend Serveron Linux, this action is also available via the command line using CLI Tools. For more information see CLI Tools.