You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to

Get Alert Instance

Resource Summary


Content Type

application/json, text/plain


API Monitoring Metrics,



Get Alert Instance

Get information about a triggered alert for an organization by using the alert instance ID.


Note: Edge imposes a quota on this API. You can call this API at most six times per minute.


Use the Get Alert History API to return information about triggered alerts, including alert IDs, for an organization.


For more information and examples of this API, see View metrics data using the API.

Resource URL /metrics/alertinstance/{instance_id}

Query Parameters

Name Values Description

Specify the name of the Edge organization.

Header Parameters

Name Values Description

OAuth token. Replace $TOKEN with your access token. See Get the tokens.

Request Body

instance_id Mention the alert instance ID true

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)