Help Center> Web Application Firewall> API Reference> APIs> Rule Management> Updating a Blacklist or Whitelist Protection Rule
Updated on 2024-04-25 GMT+08:00

Updating a Blacklist or Whitelist Protection Rule

Function

This API is used to update blacklist and whitelist protection rules. You can update IP addresses, IP address ranges, protective actions, and other information.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}

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.

rule_id

Yes

String

ID of the blacklist or whitelist rule. It can be obtained by calling the **ListWhiteblackipRule 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

name

Yes

String

Name of the whitelist or blacklist rule

addr

No

String

IP address or IP address ranges in the blacklist or whitelist rule, for example, 42.123.120.66 or 42.123.120.0/16.

description

No

String

Rule description

white

Yes

Integer

Protective action

  • 0: WAF blocks requests that hit the rule.

  • 1: WAF allows requests that hit the rule.

  • 2: WAF only record requests that hit the rule.

ip_group_id

No

String

ID of the created IP address group. Use either this parameter or addr. To add an IP address group, go to the WAF console, choose Objects > Address Groups, and click Add Address Group.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Rule ID

name

String

Name of the whitelist or blacklist rule

policyid

String

Policy ID

addr

String

IP address or IP address ranges included in the whitelist or blacklist rule.

description

String

Description of the blacklist or whitelist rule

white

Integer

Protective action

  • 0: WAF blocks requests that hit the rule.

  • 1: WAF allows requests that hit the rule.

  • 2: WAF only record requests that hit the rule.

ip_group

Ip_group object

IP address group

Table 6 Ip_group

Parameter

Type

Description

id

String

ID of the IP address group

name

String

Name of the IP address group

size

Long

Number of IP addresses or IP address ranges in the IP address group

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to update a whitelist or blacklist protection rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The rule name is changed to demo, protective action to block, description to demo, and blacklist/whitelist IP address to 1.1.1.2.

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}?enterprise_project_id=0

{
  "name" : "demo",
  "white" : 0,
  "description" : "demo",
  "addr" : "1.1.1.2"
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "5d43af25404341058d5ab17b7ba78b56",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "description" : "demo",
  "addr" : "1.1.1.2",
  "white" : 0
}

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.