Help Center> Web Application Firewall> API Reference> APIs> Rule Management> Creating a precise protection rule
Updated on 2024-04-25 GMT+08:00

Creating a precise protection rule

Function

This API is used to create a precise protection rule.

URI

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

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

ID of a protection policy. You can specify a protection policy ID to query the rules used in the protection policy. You can obtain the policy ID 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

time

Yes

Boolean

Time the precise protection rule takes effect.

  • false: The rule takes effect immediately.

  • true: The effective time is customized.

start

No

Long

Timestamp (ms) when the precise protection rule takes effect. This parameter is mandatory only when time is set to true.

terminal

No

Long

Timestamp (ms) when the precise protection rule expires. This parameter is mandatory only when time is set to true.

description

No

String

Rule description.

conditions

Yes

Array of CustomConditions objects

Match condition List

action

Yes

CustomAction object

Protective action of the precise protection rule.

priority

Yes

Integer

Priority of a rule. A small value indicates a high priority. If two rules are assigned with the same priority, the rule added earlier has higher priority. Value range: 0 to 1000.

name

Yes

String

Rule name.

Table 5 CustomConditions

Parameter

Mandatory

Type

Description

category

No

String

Field type. The options can be url, user-agent, ip, params, cookie, referer, header, request_line, method, or request.

Enumeration values:

  • url

  • user-agent

  • referer

  • ip

  • method

  • request_line

  • request

  • params

  • cookie

  • header

index

No

String

Subfield type.

  • If the field type is set to url, user-agent, ip, referer, request_line, method, or request, index can be null.

  • If the field type is set to params, header, or cookie and subfields are customized, index is set to the target custom subfield.

logic_operation

No

String

Logic for matching the condition. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix. For more details, see the console UI.

contents

No

Array of strings

Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.

value_list_id

No

String

Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.

Table 6 CustomAction

Parameter

Mandatory

Type

Description

category

Yes

String

Protection type

  • block: WAF blocks attacks.

  • pass: WAF allows requests.

  • log: WAF only logs discovered attacks.

Enumeration values:

  • block

  • pass

  • log

followed_action_id

No

String

ID of a known attack source rule. This parameter can be configured only when category is set to block.

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

id

String

Rule ID.

name

String

Rule name.

policyid

String

Policy ID.

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.

conditions

Array of conditions objects

List of matching conditions. All conditions must be met.

action

CustomAction object

Protective action of the precise protection rule.

action_mode

Boolean

This parameter is reserved and can be ignored.

priority

Integer

Priority of a rule. A small value indicates a high priority. If two rules are assigned with the same priority, the rule added earlier has higher priority. Value range: 0 to 1000.

timestamp

Long

Timestamp when the precise protection rule is created.

time

Boolean

Time the precise protection rule takes effect.

  • false: The rule takes effect immediately.

  • true: The effective time is customized.

start

Long

Timestamp (ms) when the precise protection rule takes effect. This parameter is returned only when time is set to true.

terminal

Long

Timestamp (ms) when the precise protection rule expires. This parameter is returned only when time is set to true.

producer

Integer

This parameter is reserved and can be ignored.

Table 8 conditions

Parameter

Type

Description

category

String

Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request.

index

String

Subfield

  • When the field type is url, user-agent, ip, refer, request_line, method, or request, index is not required.

  • If the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.

logic_operation

String

Logic for matching the condition.

contents

Array of strings

Content of the conditions.

value_list_id

String

Reference table ID.

Table 9 CustomAction

Parameter

Type

Description

category

String

Protection type

  • block: WAF blocks attacks.

  • pass: WAF allows requests.

  • log: WAF only logs discovered attacks.

Enumeration values:

  • block

  • pass

  • log

followed_action_id

String

ID of a known attack source rule. This parameter can be configured only when category is set to block.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 12 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 precise protection rule. Details about the query are specified by project_id and policy_id. The rule name is test55. The protective action is Block. The priority for executing the rule is 50. The matching condition is that the demo field in the header contains demo. The rule takes effect immediately.

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

{
  "name" : "test55",
  "description" : "",
  "action" : {
    "category" : "block"
  },
  "priority" : 50,
  "conditions" : [ {
    "category" : "header",
    "logic_operation" : "contain",
    "index" : "demo",
    "contents" : [ "demo" ]
  } ],
  "time" : false
}

Example Responses

Status code: 200

ok

{
  "action" : {
    "category" : "block"
  },
  "action_mode" : false,
  "conditions" : [ {
    "category" : "header",
    "index" : "demo",
    "logic_operation" : "contain",
    "contents" : [ "demo" ]
  } ],
  "description" : "",
  "name" : "test55",
  "id" : "2a3caa2bc9814c09ad73d02e3485b4a4",
  "policyid" : "1f016cde588646aca3fb19f277c44d03",
  "priority" : 50,
  "status" : 1,
  "time" : false,
  "timestamp" : 1656495488880
}

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.