Help Center> Web Application Firewall> API Reference (Kuala Lumpur Region)> API> Rule Management> Querying a Data Masking Rule
Updated on 2022-08-09 GMT+08:00
View PDF

Querying a Data Masking Rule

Function

This API is used to query a data masking rule.

URI

GET /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

Policy ID. It can be obtained by calling the API for querying the policy list.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

page

No

Integer

Page number

pagesize

No

Integer

Number of records on each page.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Number of rules

items

Array of PrivacyResponseBody objects

Rule
Table 5 PrivacyResponseBody

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

url

String

URL to which the data masking rule applies

category

String

Masked field

index

String

Name of the masked field

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded

400

Request failed

401

Insufficient token permissions

500

Internal server error

Error Codes

See Error Codes.

Parent topic: Rule Management