Help Center/ Cloud Firewall/ API Reference (Ankara Region)/ API/ Blacklist and Whitelist Management/ Deleting a Blacklist or Whitelist Rule
Updated on 2024-12-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Blacklist or Whitelist Rule

Function

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

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/black-white-list/{list_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

list_id

Yes

String

Blacklist/Whitelist ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

No

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

IdObject object

Response to the request for deleting a blacklist or whitelist
Table 5 IdObject

Parameter

Type

Description

id

String

ID

name

String

name

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

Minimum: 8

Maximum: 36

error_msg

String

Description

Minimum: 2

Maximum: 512

Example Requests

Delete the black and white list with the project id 9d80d070b6d44942af73c9c3d38e0429 and the black and white list with the id 2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a

Example Responses

Status code: 200

Blacklist/Whitelist deletion response

{
  "data" : {
    "id" : "2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a"
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.00200005",
  "error_msg" : "operation content does not exist"
}

Status Codes

Status Code

Description

200

Blacklist/Whitelist deletion response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.