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

https://apimonitoring.enterprise.apigee.com/metrics/alertinstance/{instance_id}

Path Parameters

instance_id (required)

string

Alert instance ID

Query Parameters

org (required)

string

Organization name.

Response Types

default: 

Unexpected error

Body

application/json
Error
error

string

Error message

200: 

Query results

Body

application/json
Event
id

string

Alert ID.

shared_id

string

TBD

entity_key

string

Entity key.

entity_value

string

Entity value.

dependent_entity_key

string

Dependent entity key.

dependent_entity_value

string

Dependent entity value.

component

string

Component.

pod

string

Pod.

region

string

Region.

organization

string

Organization name.

environment

string

Environment name.

name

string

Name of the alert.

type

string

Type of event. Valid values include alert or anomaly.

source

string

Source of the alert.

raw_payload

any

Raw payload of the alert. For details, see Alert.

time

string

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)

Key location: header
Parameter name: Authorization

Try this API

Request parameters
instance_id
org
Credentials
OAuth
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)