doc-exports/docs/cfw/api-ref/DeleteDomains.html

delete domains

Function

delete domains

URI

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

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
set_id	Yes	String	Domain Set 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.

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.

Table 4 Request body parameters

Parameter	Mandatory	Type	Description
object_id	Yes	String	Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.
domain_address_ids	Yes	Array of strings	domain address ids

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter	Type	Description
data	DomainSetResponseData object	delete domains response data

Table 6 DomainSetResponseData

Parameter	Type	Description
id	String	id
name	String	name

Example Requests

For the project whose project id is 14181c1245cf4fd786824efe1e2b9388, delete the domain names under the firewall whose firewall id is 546af3f8-88e9-47f2-a205-2346d7090925, the protected object id is ae42418e-f077-41a0-9d3b-5b2f5ad910 2b, the domain set id is 78719348-6d79- 477e-acec-676a29842ab2, and the domain names are "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95".

https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

{
  "domain_address_ids" : [ "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95" ],
  "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
}

Example Responses

Status code: 200

delete domains response

{
  "data" : {
    "id" : "78719348-6d79-477e-acec-676a29842ab2",
    "name" : "test26"
  }
}

Status Codes

Status Code	Description
200	delete domains response

Error Codes

See Error Codes.

Parent topic: Domain Parse and Domain Set Management