Updated on 2022-08-09 GMT+08:00

Querying False Alarm Masking Rules

Function

Querying False Alarm Masking Rules

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

policy_id

Yes

String

policyid

Table 2 Query parameters

Parameter

Mandatory

Type

Description

page

No

Integer

Page number

Default: 0

pagesize

No

Integer

Number of records on each page

Default: 10

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Number of rules in the policy

Table 5 IngnoreItem

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

timestamp

Long

Rule creation timestamp

description

String

Rule description

status

Integer

Status. The options can be 0 and 1. 0: Disabled 1: Enabled

url

String

URL of the false alarm

rule

String

Masked rule. The value can be the ID of the matched rule, all rules (all), or enumeration value of the attack type. Enumeration values of attack types: XSS attacks: xss or sqli Command injection: cmdi Malicious crawlers: robot Local file inclusion: lfi Remote file inclusion: rfi Website Trojans: webshell CC attack: cc Precise protection: custom_custom IP address blacklist and whitelist: custom_whiteblackip Geolocation access control: custom_geoip Anti-tamper protection: antitamper Anti-crawler protection: anticrawler Data leakage prevention: leakage Illegal requests: illegal Other attack types: vuln

domain

Array of strings

Protected domain name

url_logic

String

URL match logic (prefix: prefix match; equal: full match)

advanced

Advance object

Advanced settings

Table 6 Advance

Parameter

Type

Description

index

String

Index (parameter: params; Session cookie: cookie; Header field: header; Body field: body; multiple combinations: multipart)

contents

Array of strings

Specified field (available only for param, cookie, and header)

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 9 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

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.