Google Admin SDK Admin Sdk Alertcenter Alerts API
The Admin Sdk Alertcenter Alerts API from Google Admin SDK — 7 operation(s) for admin sdk alertcenter alerts.
The Admin Sdk Alertcenter Alerts API from Google Admin SDK — 7 operation(s) for admin sdk alertcenter alerts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/google-admin-sdk:google-admin-sdk-alertcenter-alerts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Google Workspace Alert Center API Alerts API
version: v1beta1
description: Generated from Google's published Discovery document for Google Workspace Alert Center API (alertcenter v1beta1,
revision 20261109). 9 operation(s).
contact:
name: Google
url: https://developers.google.com/
termsOfService: https://developers.google.com/terms
externalDocs:
url: https://developers.google.com/workspace/admin/alertcenter/
servers:
- url: https://alertcenter.googleapis.com
paths:
/v1beta1/alerts:batchDelete:
post:
operationId: alertcenter.alerts.batchDelete
summary: Batch delete alerts
description: Performs batch delete operation on alerts.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDeleteAlertsRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDeleteAlertsResponse'
4XX:
content: &id001
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id001
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
/v1beta1/alerts/{alertId}:
delete:
operationId: alertcenter.alerts.delete
summary: Delete alerts
description: Marks 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 has no effect on an alert which has already been marked for deletion.
Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` error.
parameters:
- name: alertId
in: path
required: true
description: Required. The identifier of the alert to delete.
schema:
type: string
- name: customerId
in: query
required: false
description: Optional. The unique identifier of the Google Workspace account of the customer the alert is associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity
if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Empty'
4XX:
content: &id002
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id002
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
get:
operationId: alertcenter.alerts.get
summary: Get alerts
description: Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.
parameters:
- name: alertId
in: path
required: true
description: Required. The identifier of the alert to retrieve.
schema:
type: string
- name: customerId
in: query
required: false
description: Optional. The unique identifier of the Google Workspace account of the customer the alert is associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity
if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Alert'
4XX:
content: &id003
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id003
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
/v1beta1/alerts/{alertId}/metadata:
get:
operationId: alertcenter.alerts.getMetadata
summary: Get metadata alerts
description: Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND`
error.
parameters:
- name: alertId
in: path
required: true
description: Required. The identifier of the alert this metadata belongs to.
schema:
type: string
- name: customerId
in: query
required: false
description: Optional. The unique identifier of the Google Workspace account of the customer the alert metadata is
associated with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the
caller identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/AlertMetadata'
4XX:
content: &id004
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id004
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
/v1beta1/alerts/{alertId}:undelete:
post:
operationId: alertcenter.alerts.undelete
summary: Undelete alerts
description: Restores, 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 days ago (which has been removed from the Alert Center database)
or a nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert which has not been marked for
deletion has no effect.
parameters:
- name: alertId
in: path
required: true
description: Required. The identifier of the alert to undelete.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UndeleteAlertRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Alert'
4XX:
content: &id005
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id005
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
/v1beta1/alerts:batchUndelete:
post:
operationId: alertcenter.alerts.batchUndelete
summary: Batch undelete alerts
description: Performs batch undelete operation on alerts.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchUndeleteAlertsRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BatchUndeleteAlertsResponse'
4XX:
content: &id006
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id006
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
/v1beta1/alerts:
get:
operationId: alertcenter.alerts.list
summary: List alerts
description: Lists the alerts.
parameters:
- name: customerId
in: query
required: false
description: Optional. The unique identifier of the Google Workspace account of the customer the alerts are associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity
if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
schema:
type: string
- name: filter
in: query
required: false
description: Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/workspace/admin/alertcenter/guides/query-filters)
and [Supported query filter fields](https://developers.google.com/workspace/admin/alertcenter/reference/filter-fields#alerts.list).
schema:
type: string
- name: orderBy
in: query
required: false
description: Optional. The sort order of the list results. If not specified results may be returned in arbitrary order.
You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`.
Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
schema:
type: string
- name: pageSize
in: query
required: false
description: Optional. The requested page size. Server may return fewer items than requested. If unspecified, server
picks an appropriate default.
schema:
format: int32
type: integer
- name: pageToken
in: query
required: false
description: Optional. A token identifying a page of results the server should return. If empty, a new iteration is
started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAlertsResponse'
4XX:
content: &id007
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id007
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
/v1beta1/alerts/{alertId}/feedback:
get:
operationId: alertcenter.alerts.feedback.list
summary: List feedback
description: Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND`
error.
parameters:
- name: alertId
in: path
required: true
description: Required. The alert identifier. The "-" wildcard could be used to represent all alerts.
schema:
type: string
- name: customerId
in: query
required: false
description: Optional. The unique identifier of the Google Workspace account of the customer the alert is associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity
if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
schema:
type: string
- name: filter
in: query
required: false
description: Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/workspace/admin/alertcenter/guides/query-filters)
and [Supported query filter fields](https://developers.google.com/workspace/admin/alertcenter/reference/filter-fields#alerts.feedback.list).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAlertFeedbackResponse'
4XX:
content: &id008
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id008
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
post:
operationId: alertcenter.alerts.feedback.create
summary: Create feedback
description: Creates 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 alert that is marked for deletion returns `FAILED_PRECONDITION' error.
parameters:
- name: alertId
in: path
required: true
description: Required. The identifier of the alert this feedback belongs to.
schema:
type: string
- name: customerId
in: query
required: false
description: Optional. The unique identifier of the Google Workspace account of the customer the alert is associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity
if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AlertFeedback'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/AlertFeedback'
4XX:
content: &id009
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id009
description: Error response (google.rpc.Status)
security:
- oauth2:
- https://www.googleapis.com/auth/apps.alerts
- apiKey: []
tags:
- Alerts
components:
securitySchemes:
apiKey:
type: apiKey
in: query
name: key
description: API key; accepted by methods that do not need user data.
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://accounts.google.com/o/oauth2/auth
tokenUrl: https://oauth2.googleapis.com/token
scopes:
https://www.googleapis.com/auth/apps.alerts: See and delete your domain's Google Workspace alerts, and send alert
feedback
schemas:
Alert:
properties:
source:
type: string
description: 'Required. A unique identifier for the system that reported the alert. This is output only after alert
is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail
phishing * Data Loss Prevention * Domain wide takeout * State sponsored attack * Google identity * Apps outage'
startTime:
type: string
format: google-datetime
description: Required. The time the event that caused this alert was started or detected.
data:
description: Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
type: object
createTime:
type: string
format: google-datetime
description: Output only. The time this alert was created.
metadata:
$ref: '#/components/schemas/AlertMetadata'
description: Output only. The metadata associated with this alert.
etag:
description: 'Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous
updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag`
in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned
in the response which contains alerts, and systems are expected to put that etag in the request to update alert
to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the
call to update alert, then the existing alert is overwritten blindly.'
type: string
alertId:
description: Output only. The unique identifier for the alert.
type: string
updateTime:
description: Output only. The time this alert was last updated.
type: string
format: google-datetime
deleted:
type: boolean
description: Output only. `True` if this alert is marked for deletion.
customerId:
type: string
description: Output only. The unique identifier of the Google Workspace account of the customer.
endTime:
description: Optional. The time the event that caused this alert ceased being active. If provided, the end time
must not be earlier than the start time. If not provided, it indicates an ongoing alert.
format: google-datetime
type: string
type:
type: string
description: Required. The type of the alert. This is output only after alert is created. For a list of available
alert types see [Google Workspace Alert types](https://developers.google.com/workspace/admin/alertcenter/reference/alert-types).
securityInvestigationToolLink:
type: string
description: Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955)
query for this alert.
type: object
description: An alert affecting a customer.
AlertFeedback:
properties:
alertId:
description: Output only. The alert identifier.
type: string
email:
description: Output only. The email of the user that provided the feedback.
type: string
type:
type: string
description: Required. The type of the feedback.
enum:
- ALERT_FEEDBACK_TYPE_UNSPECIFIED
- NOT_USEFUL
- SOMEWHAT_USEFUL
- VERY_USEFUL
customerId:
type: string
description: Output only. The unique identifier of the Google Workspace account of the customer.
feedbackId:
description: Output only. The unique identifier for the feedback.
type: string
createTime:
description: Output only. The time this feedback was created.
format: google-datetime
type: string
description: A customer feedback about an alert.
type: object
AlertMetadata:
type: object
properties:
severity:
type: string
description: 'The severity value of the alert. Alert Center will set this field at alert creation time, default''s
to an empty string when it could not be determined. The supported values for update actions on this field are
the following: * HIGH * MEDIUM * LOW'
customerId:
description: Output only. The unique identifier of the Google Workspace account of the customer.
type: string
status:
description: 'The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS
* CLOSED'
type: string
alertId:
description: Output only. The alert identifier.
type: string
assignee:
description: The email address of the user assigned to the alert.
type: string
updateTime:
type: string
format: google-datetime
description: Output only. The time this metadata was last updated.
etag:
description: 'Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous
updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the
`etag` in the read-modify-write cycle to perform metadata updates in order to avoid race conditions: An `etag`
is returned in the response which contains alert metadata, and systems are expected to put that etag in the request
to update alert metadata to ensure that their change will be applied to the same version of the alert metadata.
If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten
blindly.'
type: string
description: An alert metadata.
BatchDeleteAlertsRequest:
type: object
properties:
alertId:
description: Required. The list of alert IDs to delete.
type: array
items:
type: string
customerId:
description: Optional. The unique identifier of the Google Workspace account of the customer the alerts are associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller
identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
type: string
description: A request to perform batch delete on alerts.
BatchDeleteAlertsResponse:
type: object
properties:
failedAlertStatus:
additionalProperties:
$ref: '#/components/schemas/Status'
description: The status details for each failed `alert_id`.
type: object
successAlertIds:
description: The successful list of alert IDs.
type: array
items:
type: string
description: Response to batch delete operation on alerts.
BatchUndeleteAlertsRequest:
description: A request to perform batch undelete on alerts.
type: object
properties:
alertId:
type: array
items:
type: string
description: Required. The list of alert IDs to undelete.
customerId:
type: string
description: Optional. The unique identifier of the Google Workspace account of the customer the alerts are associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller
identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
BatchUndeleteAlertsResponse:
description: Response to batch undelete operation on alerts.
type: object
properties:
failedAlertStatus:
type: object
additionalProperties:
$ref: '#/components/schemas/Status'
description: The status details for each failed `alert_id`.
successAlertIds:
items:
type: string
description: The successful list of alert IDs.
type: array
Empty:
type: object
properties: {}
description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc
Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }'
GoogleRpcError:
type: object
description: The error envelope every Google API returns.
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
status:
type: string
details:
type: array
items:
type: object
ListAlertFeedbackResponse:
description: Response message for an alert feedback listing request.
type: object
properties:
feedback:
description: The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.
type: array
items:
$ref: '#/components/schemas/AlertFeedback'
ListAlertsResponse:
type: object
description: Response message for an alert listing request.
properties:
alerts:
type: array
items:
$ref: '#/components/schemas/Alert'
description: The list of alerts.
nextPageToken:
type: string
description: The token for the next page. If not empty, indicates that there may be more alerts that match the listing
request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of
the current list call.
Status:
type: object
description: 'The `Status` type defines a logical error model that is suitable for different programming environments,
including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three
pieces of data: error code, error message, and error details. You can find out more about this error model and how
to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
properties:
code:
format: int32
description: The status code, which should be an enum value of google.rpc.Code.
type: integer
details:
type: array
description: A list of messages that carry the error details. There is a common set of message types for APIs to
use.
items:
additionalProperties:
description: Properties of the object. Contains field @type with type URL.
type: object
message:
description: A developer-facing error message, which should be in English. Any user-facing error message should
be localized and sent in the google.rpc.Status.details field, or localized by the client.
type: string
UndeleteAlertRequest:
type: object
description: A request to undelete a specific alert that was marked for deletion.
properties:
customerId:
description: Optional. The unique identifier of the Google Workspace account of the customer the alert is associated
with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller
identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
type: string
x-provenance:
method: harvested
publisher: Google
source: https://alertcenter.googleapis.com/$discovery/rest?version=v1beta1
note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261109)