Method: alerts.get
Gets the specified alert. Attempting to get a nonexistent alert returns NOT_FOUND error.
HTTP request
GET https://alertcenter.googleapis.com/v1beta1/alerts/{alertId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
alertId |
string
Required. The identifier of the alert to retrieve.
|
Query parameters
| Parameters |
customerId |
string
Optional. The unique identifier of the Google Workspace account of the customer the alert is associated with. The customerId must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Alert.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/apps.alerts
For more information, see the Authorization guide.
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 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["Retrieves a specific alert using its unique identifier."],["Requires authorization with the `https://www.googleapis.com/auth/apps.alerts` scope."],["Returns a `NOT_FOUND` error if the alert does not exist."],["Optionally, you can specify the customer ID associated with the alert."],["The response body contains the alert details if the request is successful."]]],["This document details retrieving a specific alert using a `GET` request to `https://alertcenter.googleapis.com/v1beta1/alerts/{alertId}`. The `alertId` is a required path parameter, specifying the alert to be retrieved. An optional `customerId` query parameter identifies the Google Workspace account. The request body is empty. A successful response returns an `Alert` object. Authorization requires the `https://www.googleapis.com/auth/apps.alerts` OAuth scope. A request for a non-existent alert results in a `NOT_FOUND` error.\n"]]
