Google Workspace Alert Center API

Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.


To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:


REST Resource: v1beta1

getSettings GET /v1beta1/settings
Returns customer-level settings.
updateSettings PATCH /v1beta1/settings
Updates the customer-level settings.

REST Resource: v1beta1.alerts

batchDelete POST /v1beta1/alerts:batchDelete
Performs batch delete operation on alerts.
batchUndelete POST /v1beta1/alerts:batchUndelete
Performs batch undelete operation on alerts.
delete DELETE /v1beta1/alerts/{alertId}
Marks the specified alert for deletion.
get GET /v1beta1/alerts/{alertId}
Gets the specified alert.
getMetadata GET /v1beta1/alerts/{alertId}/metadata
Returns the metadata of an alert.
list GET /v1beta1/alerts
Lists the alerts.
undelete POST /v1beta1/alerts/{alertId}:undelete
Restores, or "undeletes", an alert that was marked for deletion within the past 30 days.

REST Resource:

create POST /v1beta1/alerts/{alertId}/feedback
Creates new feedback for an alert.
list GET /v1beta1/alerts/{alertId}/feedback
Lists all the feedback for an alert.