Deleting Address Group Members in Batches¶
Function¶
This API is used to delete address group members in batches.
URI¶
DELETE /v1/{project_id}/address-items
Parameter | Mandatory | Type | Description |
|---|---|---|---|
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. |
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. |
Request 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. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
set_id | Yes | String | Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). |
address_item_ids | Yes | Array of strings | List of address group member IDs. Address group member IDs 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). |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
data | Array of strings | ID list of the address group members to be deleted in batches. |
Example Requests¶
Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
{
"set_id" : "e4884376-7efb-40e7-b98b-13668d6f8b85",
"address_item_ids" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
}
Example Responses¶
Status code: 200
Return value for deleting address group members in batches.
{
"data" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
}
Status Codes¶
Status Code | Description |
|---|---|
200 | Return value for deleting address group members in batches. |
Error Codes¶
See Error Codes.