• Web Application Firewall

waf
  1. Help Center
  2. Web Application Firewall
  3. API Reference
  4. APIs
  5. False Alarm Masking Rules
  6. Adding a False Alarm Masking Rule

Adding a False Alarm Masking Rule

Function Description

This API is used to add a false alarm masking rule.

URI

  • URI format

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

  • Parameter description
    Table 1 Path parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID.

    policy_id

    Yes

    String

    Specifies the policy ID.

Request

Request parameters
Table 2 Parameter description

Parameter

Mandatory

Type

Description

url

Yes

String

Specifies a misreported URL excluding a domain name.

rule

Yes

String

Specifies the rule ID, which consists of six digits and cannot be empty.

Rule ID of a misreported event in Events whose type is not Custom. Click Handle False Alarm in the row containing the attack event to obtain the rule ID.

Response

Response parameters
Table 3 Parameter description

Parameter

Type

Description

id

String

Specifies the ID of a false alarm masking rule.

policyid

String

Specifies the policy ID.

url

String

Specifies a misreported URL excluding a domain name.

timestamp

Long

Specifies the time when a false alarm masking rule is added.

rule

String

Specifies the rule ID, which consists of six digits and cannot be empty.

Examples

Rule ID 100001 is used as example.

  • Request example
    {
      "url": "/a",
      "rule": "100001"
    }
  • Response example
    {
      "id": "6cdc116040d444f6b3e1bf1dd629f1d0",
      "policyid": "44d887434169475794b2717438f7fa78",
      "url": "/a",
      "rule": "100001",
      "timestamp": 1499817600
    }

Status Code

Table 4 describes the normal status code returned by the API.
Table 4 Status code

Status Code

Description

Meaning

200

OK

The request has succeeded.

For details about error status codes, see Status Codes.