Updated on 2024-07-25 GMT+08:00

Deleting a Domain Name from a Dedicated WAF Instance

Function

This API is used for deleting a domain name from 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

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

ID of the enterprise project. It can be obtained by calling the ListEnterpriseProject API of EPS.

keepPolicy

No

Boolean

Whether to retain the rule

Default: false

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

policyid

String

Policy ID

region

String

Region ID

protect_status

Integer

WAF status of the protected domain name.

  • -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.

  • 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.

  • 1: Enabled. WAF detects attacks based on the configured policy.

access_status

Integer

Whether a domain name is connected to WAF.

  • 0: disconnected

  • 1: connected

flag

Map<String,String>

Special domain name identifier. This parameter is used for console only.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

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-xx-1",
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
  "protect_status" : 1,
  "access_status" : 0,
  "web_tag" : "",
  "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.