Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Creating a Global Protection Whitelist (Formerly False Alarm Masking) Rule
Updated on 2024-04-25 GMT+08:00

Creating a Global Protection Whitelist (Formerly False Alarm Masking) Rule

Function

This API is used to create a global protection whitelist (formerly false alarm masking) rule.

URI

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

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.

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

domain

Yes

Array of strings

Domain name or website to be protected. If the array length is 0, the rule takes effect for all domain names or websites.

conditions

Yes

Array of CreateCondition objects

Condition list

mode

Yes

Integer

The value is fixed at 1, indicating v2 false alarm masking rules. v1 is used only for compatibility with earlier versions, and false alarm rules cannot be created in v1.

rule

Yes

String

Items to be masked. You can provide multiple items and separate them with semicolons (;).

  • If you want to block a specific built-in rule, the value of this parameter is the rule ID. To query the rule ID, go to the WAF console, choose Policies and click the target policy name. On the displayed page, in the Basic Web Protection area, select the Protection Rules tab, and view the ID of the specific rule. You can also query the rule ID in the event details.

  • If you want to mask a type of basic web protection rules, set this parameter to the name of the type of basic web protection rules. xss: XSS attacks webshell: Web shells vuln: Other types of attacks sqli: SQL injection attack robot: Malicious crawlers rfi: Remote file inclusion lfi: Local file inclusion cmdi: Command injection attack

  • To bypass the basic web protection, set this parameter to all.

  • To bypass all WAF protection, set this parameter to bypass.

description

No

String

Description of a masking rule

Table 5 CreateCondition

Parameter

Mandatory

Type

Description

category

Yes

String

Field type. The value can be ip, url, params, cookie, or header.

contents

Yes

Array of strings

Content. The array length is limited to 1. The content format varies depending on the field type. For example, if the field type is ip, the value must be an IP address or IP address range. If the field type is url, the value must be in the standard URL format. IF the field type is params, cookie, or header, the content format is not limited.

logic_operation

Yes

String

The matching logic varies depending on the field type. For example, if the field type is ip, the logic can be equal or not_equal. If the field type is url, params, cookie, or header, the logic can be equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix.

check_all_indexes_logic

No

Integer

This parameter is reserved and can be ignored.

index

No

String

If the field type is ip and the subfield is the client IP address, the index parameter is not required. If the subfield type is X-Forwarded-For, the value is x-forwarded-for. If the field type is params, header, or cookie, and the subfield is user-defined, the value of index is the user-defined subfield.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

timestamp

Long

Timestamp the rule was created.

description

String

Rule Description

status

Integer

Rule status. The value can be 0 or 1.

  • 0: The rule is disabled.

  • 1: The rule is enabled.

rule

String

ID of the built-in rule to be masked. You can query the rule ID by choosing Policies > Policy Name > Basic Web Protection > Protection Rules on the WAF console or on the event details page.

mode

Integer

The value is fixed at 1, indicating v2 false alarm masking rules are used. v1 is used only for compatibility with earlier versions, and false alarm rules cannot be created in v1.

conditions

Array of Condition objects

Condition list

domain

Array of strings

Protected domain name or website

Table 7 Condition

Parameter

Type

Description

category

String

Field type. The value can be ip, url, params, cookie, or header.

contents

Array of strings

Content. The array length must be 1. The content format varies depending on field types. For example, if the field type is ip, the value must be an IP address or IP address range. If the field type is url, the value must be a URL in standard format. If the field type is params, cookie, or header, the content format is not limited.

logic_operation

String

The matching logic varies depending on the field type. For example, if the field type is ip, the logic can be equal or not_equal. If the field type is url, params, cookie, or header, the logic can be equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix.

check_all_indexes_logic

Integer

This parameter is reserved and can be ignored.

index

String

If the field type is ip and the subfield is the client IP address, the index parameter does not exist. If the subfield type is X-Forwarded-For, the value is x-forwarded-for. If the field type is params, header, or cookie, and the subfield is user-defined, the value of index is the user-defined subfield.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to create a global whitelist protect (the formerly false alarm masking) rule. Details about the rule are specified by project_id and policy_id. The domain name is we.test.418lab.cn, the URL contains x.x.x.x, the description is demo, and the ID of the rule to be masked is 091004.

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

{
  "domain" : [ "we.test.418lab.cn" ],
  "conditions" : [ {
    "category" : "url",
    "logic_operation" : "contain",
    "contents" : [ "x.x.x.x" ],
    "index" : null
  } ],
  "mode" : 1,
  "description" : "demo",
  "rule" : "091004"
}

Example Responses

Status code: 200

OK

{
  "id" : "a57f20ced01e4e0d8bea8e7c49eea254",
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "timestamp" : 1650522310447,
  "description" : "demo",
  "status" : 1,
  "rule" : "091004",
  "mode" : 1,
  "conditions" : [ {
    "category" : "url",
    "contents" : [ "x.x.x.x" ],
    "logic_operation" : "contain"
  } ],
  "domain" : [ "we.test.418lab.cn" ]
}

Status Codes

Status Code

Description

200

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.