Help Center/ Global Accelerator/ API Reference/ API/ Listener/ Deleting a Listener
Updated on 2025-08-29 GMT+08:00
View PDF

Deleting a Listener

Function

This API is used to delete a listener.

Constraints

Before deleting the listener, you must delete all associated endpoint groups.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/listeners/{listener_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

listener_id

Yes

String

Specifies the listener ID.

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

Status code: 204

Listener deleted.

None

Example Requests

Deleting a listener

DELETE https://{ga_endpoint}/v1/listeners/1b11747a-b139-492f-9692-2df0b1c87193

Example Responses

None

Status Codes

Status Code

Description

204

Listener deleted.

Error Codes

See Error Codes.

Parent Topic: Listener