Method: projects.notificationChannels.list

Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the notificationChannelDescriptors.list method.

HTTP request

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

Path parameters

Parameters
name

string

Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the notificationChannels.get operation.

Authorization requires the following IAM permission on the specified resource name:

  • monitoring.notificationChannels.list

Query parameters

Parameters
filter

string

Optional. If provided, this field specifies the criteria that must be met by notification channels to be included in the response.

For more details, see sorting and filtering.
orderBy

string

Optional. A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.

For more details, see sorting and filtering.
pageSize

integer

Optional. 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

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

Request body

The request body must be empty.

Response body

The notificationChannels.list response.

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

JSON representation 
{
  "notificationChannels": [
    {
      object (NotificationChannel)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
notificationChannels[]

object (NotificationChannel)

The notification channels defined for the specified project.
nextPageToken

string

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

integer

The total number of notification channels in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158

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 the Authentication Overview.