Google

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.

Productivity & workspace#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 11

alerts

  • POSTPerforms batch delete operation on alerts./v1beta1/alerts:batchDeletePerforms batch delete operation on alerts.
  • POSTPerforms batch undelete operation on alerts./v1beta1/alerts:batchUndeletePerforms batch undelete operation on alerts.
  • GETGets the specified alert/v1beta1/alerts/:alertId?customerId=stringGets the specified alert. Attempting to get a nonexistent alert returns NOT_FOUND error.
  • DELETEMarks the specified alert for deletion/v1beta1/alerts/:alertId?customerId=stringMarks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion…
  • GETReturns the metadata of an alert/v1beta1/alerts/:alertId/metadata?customerId=stringReturns the metadata of an alert. Attempting to get metadata for a non-existent alert returns NOT_FOUND error.
  • GETLists the alerts./v1beta1/alerts?customerId=string&filter=string&orderBy=string&pageSize=0&pageToken=stringLists the alerts.
  • POSTRestores, or "undeletes", an alert that was marked for deletion within the past 30 days/v1beta1/alerts/:alertId:undeleteRestores, or "undeletes", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30…

alerts.feedback

  • GETLists all the feedback for an alert/v1beta1/alerts/:alertId/feedback?customerId=string&filter=stringLists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns NOT_FOUND error.
  • POSTCreates new feedback for an alert/v1beta1/alerts/:alertId/feedback?customerId=stringCreates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns NOT_FOUND error. Attempting to create a feedback for an…

v1beta1

  • GETReturns customer-level settings./v1beta1/settings?customerId=stringReturns customer-level settings.
  • PATCHUpdates the customer-level settings./v1beta1/settings?customerId=stringUpdates the customer-level settings.

API details

Base URL
https://alertcenter.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
11 operations on 8 pathsGET 5POST 4PATCH 1DELETE 1
Main resources
alerts 7alerts.feedback 2v1beta1 2
Response formats
application/json
Description format
Google API Discovery, API version v1beta1

How to test the Google Workspace Alert Center API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Google Workspace Alert Center API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Performs batch delete operation on alerts.” (POST /v1beta1/alerts:batchDelete), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the 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. It is listed under Productivity & workspace and has 11 endpoints.

Who publishes the Google Workspace Alert Center API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Google Workspace Alert Center API?

Requests go to https://alertcenter.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Google Workspace Alert Center API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Google Workspace Alert Center API have?

11 operations on 8 paths (5 GET, 4 POST, 1 PATCH, 1 DELETE). The largest groups are alerts, alerts.feedback, v1beta1.

Is forking the Google Workspace Alert Center API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.