Updated on 2025-11-21 GMT+08:00

Deleting a Domain Name Group

Function

This API is used to delete a domain name group.

URI

DELETE /v1/{project_id}/domain-set/{set_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

set_id

Yes

String

Definition

Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID. If you plan enterprise projects based on your organization's plan, each enterprise project will have such an ID. After this parameter is configured, you can filter assets by enterprise project.

Constraints

N/A

Range

N/A

Default Value

0

fw_instance_id

Yes

String

Definition

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

DomainSetResponseData object

Definition

Returned data for deleting a domain name group.

Range

N/A

Table 5 DomainSetResponseData

Parameter

Type

Description

id

String

Definition

Domain name group ID.

Range

N/A

name

String

Definition

Domain group name.

Range

N/A

Example Requests

Delete domain name group 89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a from firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default

Example Responses

Status code: 200

OK

{
  "data" : {
    "id" : "89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a",
    "name" : "test"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.