Help Center/ EventGrid/ API Reference/ APIs/ Event Channel Management/ Deleting a Custom Event Channel
Updated on 2025-11-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Custom Event Channel

Function

This API is used to delete a custom event channel.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

DELETE /v1/{project_id}/channels/{channel_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.

channel_id

Yes

String

ID of the event channel.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token 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 the user token.

Response Parameters

Status code: 204

Operation successful.

None

Example Requests

Delete a custom event channel.

DELETE https://{endpoint}/v1/{project_id}/channels/{channel_id}

Example Responses

None

Status Codes

Status Code

Description

204

Operation successful.

Error Codes

See Error Codes.

Parent topic: Event Channel Management