Method: projects.notificationChannelDescriptors.list

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

HTTP request

GET https://monitoring.googleapis.com/v3/{name}/notificationChannelDescriptors

Path parameters

Parameters
name

string

Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

projects/[PROJECT_ID_OR_NUMBER]

Note that thisnames the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use thenotificationChannelDescriptors.get operation, instead.

Authorization requires the followingIAM permission on the specified resourcename:

  • monitoring.notificationChannelDescriptors.list

Query parameters

Parameters
pageSize

integer

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

pageToken

string

If non-empty,pageToken must contain a value returned as thenextPageToken in a previous response to request the next set of results.

Request body

The request body must be empty.

Response body

ThenotificationChannelDescriptors.list response.

If successful, the response body contains data with the following structure:

JSON representation
{"channelDescriptors":[{object (NotificationChannelDescriptor)}],"nextPageToken":string}
Fields
channelDescriptors[]

object (NotificationChannelDescriptor)

The monitored resource descriptors supported for the specified project, optionally filtered.

nextPageToken

string

If not empty, indicates that there may be more results that match the request. Use the value in thepageToken field in a subsequent request to fetch the next set of results. If empty, all results have been returned.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-23 UTC.