Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Examples: Alarms

Monitors can have alarms associated with them. This section explains how to do the following through the REST API:

  • Creating alarm templates
  • Setting up SNMP managers and lists of email recipients, specifying where to send alarms when they are triggered

We will begin with the alarm recipients, as these are a prerequisite when defining an alarm template. We then proceed to show how to create such templates, which among other things hold the trigger conditions for alarms.

Instances of alarms cannot be created in isolation through the REST API. Rather, alarm instances are created in the course of creating a monitor (most conveniently by referring to an alarm template, but optionally without doing so), as described in the section Creating a Monitor with an Alarm. However, you can perform some operations on alarm instances through the API:

  • list alarm instances
  • retrieve an individual alarm instance
  • suppress an alarm instance so that it will never trigger, even if thresholds are exceeded
  • delete an alarm instance.

Alarm Email Lists

Creating an Alarm Email List

Retrieving All Alarm Email Lists

Here is how to retrieve a list of all alarm email lists and see what IDs they have been assigned.

SNMP Managers

Creating an SNMP Manager

The URL should be defined as shown below.

To create a version 2c SNMP manager, use the following settings:

To create a version 3 SNMP manager, use the following settings:

Retrieving All SNMP Managers

Here is how to retrieve a list of all SNMP managers and see what IDs they have been assigned.

Alarm Templates

Creating an Alarm Template

In practice, probably only one of email and snmp will be used.

Retrieving All Alarm Templates

Modifying an Existing Alarm Template

If you need to adjust some settings in an alarm template, you can do so as follows: