Updated on 2026-01-06 GMT+08:00

Adding a Blacklist or Whitelist to a Policy

Function

Add a blacklist or whitelist to a policy.

Calling Method

For details, see Calling APIs.

URI

POST /v1/cnad/policies/{policy_id}/ip-list/add

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

policy_id

Yes

String

Policy ID.

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 used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Content-Type

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Type. white: whitelist. black: blacklist.

ip_list

Yes

Array of strings

IP addresses.

Response Parameters

Status code: 200

OK

None

Example Requests

Add IP addresses 1.1.1.1 and 2.2.2.2 to the whitelist of the specified protection policy.

POST https://{endpoint}/v1/cnad/policies/{policy_id}/ip-list/add

{
  "type" : "white",
  "ip_list" : [ "1.1.1.1", "2.2.2.2" ]
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.