Updated on 2024-04-25 GMT+08:00

Updating a Data Masking Rule

Function

This API is used to update a data masking rule.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/privacy/{rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

policy_id

Yes

String

Policy ID. It can be obtained by calling the ListPolicy API.

rule_id

Yes

String

ID of the data masking rule. You can obtain the rule ID by calling the ListPrivacyRule API which is used for querying the data masking rule list.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Default: application/json;charset=utf8

Table 4 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.

  • Params: The params field in requests

  • Cookie: Web visitors distinguished by cookie

  • Header: Custom HTTP header

  • Form: Forms

Enumeration values:

  • params

  • cookie

  • header

  • form

index

Yes

String

Masked field name. Set the field name based on the masked field. The masked field will not be displayed in logs. The masked field name cannot exceed 2,048 bytes. Only digits, letters, underscores (_), and hyphens (-) are allowed.

description

No

String

(Optional) A description of the rule.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

timestamp

Long

Time the rule was created. The value is a 13-digit timestamp in ms.

status

Integer

Rule status. The value can be 0 or 1.

  • 0: The rule is disabled.

  • 1: The rule is enabled.

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.

  • Params: The params field in requests

  • Cookie: Web visitors distinguished by cookie

  • Header: Custom HTTP header

  • Form: Forms

Enumeration values:

  • params

  • cookie

  • header

  • form

index

String

Masked field name. Set the field name based on the masked field. The masked field will not be displayed in logs.

description

String

(Optional) A description of the rule.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to update a data masking rule. The project ID is specified by project_id and the policy ID is specified by policy_id. The rule ID is specified by rule_id. The url of the rule is /demo, the masking field is cookie, the masking field name is demo1, and the rule description is demo.

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

{
  "url" : "/demo",
  "category" : "cookie",
  "index" : "demo1",
  "description" : "demo"
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "97e4d35f375f4736a21cccfad77613eb",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "description" : "demo",
  "url" : "/demo",
  "category" : "cookie",
  "index" : "demo1"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.