Google Workspace Alert Center API
Stay organized with collections
Save and categorize content based on your preferences.
Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.
Service: alertcenter.googleapis.com
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:
https://alertcenter.googleapis.com
REST Resource: v1beta1
| Methods |
getSettings |
GET /v1beta1/settings
Returns customer-level settings. |
updateSettings |
PATCH /v1beta1/settings
Updates the customer-level settings. |
| Methods |
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. |
| Methods |
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. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Google Workspace Alert Center API\n\nManages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.\n\n- [REST Resource: v1beta1](#v1beta1)\n- [REST Resource: v1beta1.alerts](#v1beta1.alerts)\n- [REST Resource: v1beta1.alerts.feedback](#v1beta1.alerts.feedback)\n\nService: alertcenter.googleapis.com\n-----------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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:\n\n- \u003chttps://alertcenter.googleapis.com/$discovery/rest?version=v1beta1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- `https://alertcenter.googleapis.com`\n\nREST Resource: [v1beta1](/workspace/admin/alertcenter/reference/rest/v1beta1/TopLevel)\n--------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------|----------------------------------------------------------------|\n| [getSettings](/workspace/admin/alertcenter/reference/rest/v1beta1/TopLevel/getSettings) | `GET /v1beta1/settings` Returns customer-level settings. |\n| [updateSettings](/workspace/admin/alertcenter/reference/rest/v1beta1/TopLevel/updateSettings) | `PATCH /v1beta1/settings` Updates the customer-level settings. |\n\nREST Resource: [v1beta1.alerts](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts)\n-------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|\n| [batchDelete](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/batchDelete) | `POST /v1beta1/alerts:batchDelete` Performs batch delete operation on alerts. |\n| [batchUndelete](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/batchUndelete) | `POST /v1beta1/alerts:batchUndelete` Performs batch undelete operation on alerts. |\n| [delete](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/delete) | `DELETE /v1beta1/alerts/{alertId}` Marks the specified alert for deletion. |\n| [get](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/get) | `GET /v1beta1/alerts/{alertId}` Gets the specified alert. |\n| [getMetadata](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/getMetadata) | `GET /v1beta1/alerts/{alertId}/metadata` Returns the metadata of an alert. |\n| [list](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/list) | `GET /v1beta1/alerts` Lists the alerts. |\n| [undelete](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/undelete) | `POST /v1beta1/alerts/{alertId}:undelete` Restores, or \"undeletes\", an alert that was marked for deletion within the past 30 days. |\n\nREST Resource: [v1beta1.alerts.feedback](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts.feedback)\n-------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|\n| [create](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts.feedback/create) | `POST /v1beta1/alerts/{alertId}/feedback` Creates new feedback for an alert. |\n| [list](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts.feedback/list) | `GET /v1beta1/alerts/{alertId}/feedback` Lists all the feedback for an alert. |"]]
