Updated on 2024-04-15 GMT+08:00

Deleting a Domain Name from a Dedicated WAF Instance

Function

This API is used to delete a domain name protected with a dedicated WAF instance.

URI

DELETE /v1/{project_id}/premium-waf/host/{host_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.

host_id

Yes

String

ID of the domain name protected by the dedicated WAF engine

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.

keepPolicy

No

Boolean

Whether to retain the rule. false: The policy for the domain name will not be retained. true: The policy for the domain name will be retained. If the policy used for the domain name you want to delete is also used for other domain names, this parameter must be left blank.

Default: 1

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type.

Default: application/json;charset=utf8

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).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name

extend

Map<String,String>

Extended field, which is used to save some configuration information about the protected domain name.

region

String

Region ID. This parameter is included when the domain name was added to WAF through the console. This parameter is left blank when the domain name was added to WAF by calling an API. You can query the region ID on the Regions and Endpoints page on the Cloud website.

flag

Flag object

Special identifier, which is used on the console.

description

String

Domain name description

policyid

String

ID of the policy initially used to the domain name. You can call the ListPolicy API to query the policy list and view the ID of a specific policy.

protect_status

Integer

WAF status of the protected domain name.

  • -1: The WAF protection is bypassed. Requests of the domain name are directly sent to the backend server and do not pass through WAF.

  • 0: The WAF protection is suspended. WAF only forwards requests destined for the domain name and does not detect attacks.

  • 1: The WAF protection is enabled. WAF detects attacks based on the policy you configure.

access_status

Integer

Domain name access status. The value can be 0 or 1. 0: The website traffic has not been routed to WAF. 1: The website traffic has been routed to WAF.

web_tag

String

Website name, which is the same as the website name in the domain name details on the WAF console.

host_id

String

Domain name ID, which is the same as the value of *id. This field is redundant.

Table 5 Flag

Parameter

Type

Description

pci_3ds

String

Whether the website passes the PCI 3DS certification check.

  • true: The website passed the PCI 3DS certification check.

  • false: The website failed the PCI 3DS certification check.

Enumeration values:

  • true

  • false

pci_dss

String

Whether the website passed the PCI DSS certification check.

  • true: The website passed the PCI DSS certification check.

  • false: The website failed the PCI DSS certification check.

Enumeration values:

  • true

  • false

cname

String

The CNAME record being used.

  • old: The old CNAME record is used.

  • new: The new CNAME record is used.

Enumeration values:

  • old

  • new

is_dual_az

String

Whether WAF support Multi-AZ DR

  • true: WAF supports multi-AZ DR.

  • false: WAF does not support multi-AZ DR.

Enumeration values:

  • true

  • false

ipv6

String

Whether IPv6 protection is supported.

  • true: IPv6 protection is supported.

  • false: IPv6 protection is not supported.

Enumeration values:

  • true

  • false

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

DELETE https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}?enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "id" : "ee896796e1a84f3f85865ae0853d8974",
  "hostname" : "www.demo.com",
  "region" : "xx-xxxx-x",
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
  "protect_status" : 1,
  "access_status" : 0,
  "hostid" : "ee896796e1a84f3f85865ae0853d8974"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request

401

The token does not have the required permission.

500

Internal server error.

Error Codes

See Error Codes.