Deleting an Address Group Member¶

Function¶

This API is used to delete a member from an address group.

DELETE /v1/{project_id}/address-items/{item_id}

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
item_id	Yes	String	Address group member ID, which can be obtained by calling the API for querying address group members. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects).
project_id	Yes	String	Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.
fw_instance_id	No	String	Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by referring to Obtaining a User Token.
Content-Type	Yes	String	Content type. It can only be set to application/json.

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
data	Array of AddressItemId objects	Delete an address group member ID.

**Table 5** AddressItemId¶
Parameter	Type	Description
id	String	ID of an address group member.
name	String	Name of an address group member.

Status code: 400

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Delete address group member 65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae from project 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae

Status code: 200

Return value for deleting an address group member.

{
  "data" : {
    "id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae",
    "name" : "test"
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.0020016",
  "error_msg" : "Incorrect instance status."
}

Status Code	Description
200	Return value for deleting an address group member.
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

last updated: 2025-01-21 13:19 UTC - commit: abe94c6df6d30c3b44340c2119ffd81f9990504a