Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Rule Management/ Creating a Whitelist or Blacklist Rule

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

View PDF

Creating a Whitelist or Blacklist Rule

Function

This API is used to create a blacklist or whitelist rule.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
policy_id	Yes	String	Policy ID. It can be obtained by calling the API for querying the policy list.

Request Parameters

**Table 2** 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 3** Request body parameters
Parameter	Mandatory	Type	Description
addr	Yes	String	IP addresses in the blacklist or whitelist rule
description	No	String	Description of the blacklist or whitelist rule
white	No	Integer	Protective action for the rule. The options are 0, 1, and 2. 0: Block. 1: Allow. 2: Log only.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Rule ID
policyid	String	Policy ID
ip	String	Blacklist and whitelist
white	Integer	Type. The options are 0 and 1. 0: Block. 1: Allow
timestamp	Long	Time the rule was created

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error code message

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error code message

Status code: 500

**Table 7** 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	Insufficient token permissions
500	Internal server error

Error Codes

See Error Codes.

Parent topic: Rule Management

Previous topic: Querying the List of Blacklist and Whitelist Rules

Next topic: Updating a Whitelist or Blacklist Rule

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.