Help Center/ EventGrid/ API Reference/ APIs/ Event Channel Management/ Obtaining Event Channel Details

Updated on 2025-11-07 GMT+08:00

View PDF

Obtaining Event Channel Details

Function

This API is used to obtain the details about an 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

GET /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: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	ID of the event channel.
name	String	Name of the event channel.
description	String	Description of the event channel.
provider_type	String	Event channel provider type, which can be OFFICIAL (official event channel), CUSTOM (custom event channel), or PARTNER (partner event channel).
created_time	String	UTC time when the event channel is created.
updated_time	String	UTC time when the event channel is updated.
enterprise_project_id	String	Enterprise project ID.

Example Requests

Obtain event channel details.

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

Example Responses

Status code: 200

Operation successful.

{
  "id" : "bd14144e-8f3c-43d6-bdfd-bf09b52c2b96",
  "name" : "channel",
  "description" : "first channel",
  "provider_type" : "CUSTOM",
  "created_time" : "2021-12-09 09:00:00",
  "updated_time" : "2021-12-09 09:00:00",
  "enterprise_project_id" : "string"
}