get /alertinstance/{instance_id}
Gets information about a triggered alert for an organization.
Use the Get alert history API (/alerthistory
) to return information about triggered alerts, including alert IDs, for an organization.
Note: You can call this API at most six times per minute.
For more information and examples of this API, see View metrics data using the API.
HTTP request
Path Parameters
instance_id (required) | Alert instance ID |
Query Parameters
org (required) | Organization name. |
Response Types
default:
Unexpected error
200:
Query results
Body
id | Alert ID. |
shared_id | TBD |
entity_key | Entity key. |
entity_value | Entity value. |
dependent_entity_key | Dependent entity key. |
dependent_entity_value | Dependent entity value. |
component | Component. |
pod | Pod. |
region | Region. |
organization | Organization name. |
environment | Environment name. |
name | Name of the alert. |
type | Type of event. Valid values include |
source | Source of the alert. |
raw_payload | Raw payload of the alert. For details, see Alert. |
time | Time the alert was triggered. |
Authentication Requirements
For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)