Adding a Data Masking Rule

Function

This API is used to add a data masking rule.

URI

POST /v1/{project_id}/waf/policy/{policy_id}/privacy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
policy_id	Yes	String	Protection policy ID. You can call the ListPolicy API to obtain the policy ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	auth token
Content-Type	Yes	String	Content type Default: application/json;charset=utf8

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
url	Yes	String	URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin/xxx or /admin/. The asterisk () indicates the path prefix.
category	Yes	String	Masked field Enumeration values: params cookie header form
index	Yes	String	Field name
description	No	String	Rule description

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Rule ID
policyid	String	Policy ID
url	String	URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin/xxx or /admin/. The asterisk () indicates the path prefix.
category	String	Masked field Enumeration values: params cookie header form
index	String	Field name

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Example Requests

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/privacy?enterprise_project_id=0

{
  "url" : "/login",
  "category" : "params",
  "index" : "password",
  "description" : ""
}

Example Responses

Status code: 200

{
  "category" : "params",
  "description" : "",
  "id" : "41a5674e03a1470a90ac4761ec4657b4",
  "index" : "password",
  "policyid" : "1f016cde588646aca3fb19f277c44d03",
  "status" : 1,
  "timestamp" : 1656504425319,
  "url" : "/login"
}