Help Center/ Global Accelerator/ API Reference/ API/ IP Address Group/ Deleting an IP Address Group
Updated on 2024-11-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting an IP Address Group

Function

This API is used to delete an IP address group.

This API is an asynchronous API. The deletion is not complete even after a response is returned. You can call the API for querying the IP address group details to check whether the deletion is complete. If the IP address group status is not found, the IP address group has been deleted. If the IP address group is associated with a listener, disassociate the IP address group from the listener before deleting the IP address group.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/ip-groups/{ip_group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

ip_group_id

Yes

String

Specifies the ID of the IP address group.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

None

Example Requests

Deleting an IP address group

DELETE https://{ga_endpoint}/v1/ip-groups/e8996cd6-28cf-4ff2-951e-fa8ac895a6cd

Example Responses

None

Status Codes

Status Code

Description

204

Deleted.

Error Codes

See Error Codes.

Parent Topic: IP Address Group