IBM Cloud Monitoring Alerts API

Live

IBM Cloud Monitoring Alerts API

+ Day(s) remaining in the trial

Overview

The IBM Cloud Monitoring Alerts API provides a query-based alerting solution that works with the existing features of the Monitoring service. In order to set an alert, you must define: * An alert rule that describes the metric query to be monitored, the threshold value, and the actions (notification) to take when the threshold is crossed * An alert notification that describes how to notify something or someone that the alert rule has been triggered. You can notify through email, PagerDuty, or Webhook.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Cloud Monitoring Alerts API:

Alert History

Alert History
Show the alert history for a Bluemix space.
Show the alert history for a Bluemix space.

GET   /alert/history

			https://metrics.ng.bluemix.net/v1/alert/history
		
Keys
Header parameters

X-Auth-Scope-Id

HEADER , required

Set this field to the space GUID. The GUID must be prefixed with s- to identify a space.

X-Auth-User-Token

HEADER , required

UAA token, IAM token, or API key used for authentication. A token or API key must be prefixed with one of the following values: `apikey`, `iam` or `uaa` For example: `X-Auth-User-Token: apikey SomeIAMGeneratedKey`

Path and Query parameters

rule

STRING , optional

The rule name by which to filter the history results.

Request code
								
HttpResponse<String> response = Unirest.get("https://metrics.ng.bluemix.net/v1/alert/history?rule=string") .header("x-auth-scope-id", "string") .header("x-auth-user-token", "string") .asString();
Response model

200

OK

Body

from_level

STRING , optional

The alert level for the rule before the alert state changed.

notifications

ARRAY , optional

The names of the notification targets that were invoked. You can list one or more notification targets.

rule

STRING , required

The name of the alert rule that was triggered.

timestamp

STRING , required

The timestamp of the alert rule that was triggered.

to_level

STRING , optional

The alert level for the rule after the alert state changed.

404

The history for the rule or notification in the request was not found.

Body

Code

STRING , optional

Status code.

message

STRING , optional

Description of the message associated with the code.

Response example

200

OK

								{
  "from_level" : string,
  "notifications" : [array],
  "rule" : string,
  "timestamp" : string,
  "to_level" : string
}
							

404

The history for the rule or notification in the request was not found.

								{
  "Code": "404",
  "message": "The history for the rule or notification in the request was not found."
}
							

Loading content...