doc-exports/docs/wafd/api-ref/CreateAntileakageRules.html

Creating an Information Leakage Protection Rule

Function

This API is used to create an information leakage protection rule.

URI

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

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 ListPolicy API.

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	auth token
Content-Type	Yes	String	Content type.

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
url	Yes	String	URL to which the rule applies.
category	Yes	String	Sensitive information type in the information leakage prevention rule. sensitive: The rule masks sensitive user information, such as ID code, phone numbers, and email addresses. code: The rule blocks response pages of specified HTTP response code.
contents	Yes	Array of strings	Content corresponding to the sensitive information type. Multiple options can be set. When category is set to code, the pages that contain the following HTTP response codes will be blocked: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504 and 507. When category is set to sensitive, parameters phone, id_card, and email can be set.
action	Yes	action object	Protective action of the Antileakage rule
description	No	String	Rule description

Table 4 action

Parameter	Mandatory	Type	Description
category	Yes	String	Protection type block: WAF blocks attacks. log: WAF only logs discovered attacks.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter	Type	Description
id	String	Rule ID
url	String	URL to which the rule applies.
category	String	Sensitive information type in the information leakage prevention rule. sensitive: The rule masks sensitive user information, such as ID code, phone numbers, and email addresses. code: The rule blocks response pages of specified HTTP response code.
contents	Array of strings	Content corresponding to the sensitive information type. Multiple options can be set. When category is set to code, the pages that contain the following HTTP response codes will be blocked: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504 and 507. When category is set to sensitive, parameters phone, id_card, and email can be set.
timestamp	Long	Timestamp when the rule was created.
description	String	Rule description.
status	Integer	Rule status. The value can be: 0: The rule is disabled. 1: The rule is enabled.

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

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antileakage?

{
  "url" : "/attack",
  "category" : "sensitive",
  "contents" : [ "id_card" ],
  "action" : {
    "category" : "block"
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "82c4f04f84fd4b2b9ba4b4ea0df8ee82",
  "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
  "timestamp" : 1668152426471,
  "description" : "demo",
  "status" : 1,
  "url" : "/attack",
  "category" : "sensitive",
  "action" : {
    "category" : "block"
  },
  "contents" : [ "id_card" ]
}

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.

Parent topic: Rule Management