Method: projects.notificationChannels.delete

Deletes a notification channel.

Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to notificationChannels.create, notificationChannels.delete and notificationChannels.patch.

HTTP request

DELETE https://monitoring.googleapis.com/v3/{name}

Path parameters

Parameters
name

string

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

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

  • monitoring.notificationChannels.delete

Query parameters

Parameters
force

boolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, this operation will fail if the notification channel is referenced by existing alerting policies.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.