- API >
- Public API Resources >
- Measurements and Alerts >
- Alert Configurations >
- Create an Alert Configuration
Create an Alert Configuration¶
On this page
Base URL: https://<ops-manager-host>
¶
Syntax¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required | Group identifier. |
Request Query Parameters¶
Field | Required/Optional | Description |
---|---|---|
pageNum |
Optional. | The page to return. |
itemsPerPage |
Optional. | Maximum number of items to return per page. Default is 100. |
envelope |
Optional. | A boolean that specifies whether or not to wrap the response in an envelope. |
Request Body Parameters¶
Note
Alert configurations vary. An alert configuration may only include a subset of these elements.
Name | Type | Description |
---|---|---|
eventTypeName |
string | Required. The type of event that will trigger an alert.
|
enabled |
boolean | If omitted, the configuration is disabled. |
matchers |
object array | Rules to apply when matching an object against this alert configuration. Only entities that match all these rules will be checked for an alert condition. You can filter using the |
matchers.fieldName |
string | The name of the field in the target object to match on.
All other types of alerts do not support matchers. |
matchers.operator |
string | The operator to test the field’s value. Possible values are:
|
matchers.value |
string | The value to test with the specified operator. If
|
notifications |
object array | Required. Notifications to send when an alert condition is detected. |
notifications.typeName |
string | The type of alert notification. Possible values are:
|
notifications.intervalMin |
number | The number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. |
notifications.delayMin |
number | The number of minutes to wait after an alert condition is detected before sending out the first notification. |
notifications.emailEnabled |
boolean | Determines if email notifications should be sent. For notifications of type
GROUP and USER . |
notifications.smsEnabled |
boolean | Determines if SMS notifications should be sent. For notifications of type
GROUP and USER . |
notifications.username |
string | The name of an Ops Manager user to which to send notifications. Specify a user in the
group that owns the alert configuration. For
notifications of type USER . |
notifications.snmpAddress |
string | Hostname and port to send SNMP traps to. At this time
Ops Manager is only able to send SNMP traps to the standard SNMP
port (162). For SNMP notifications. Ops Manager
uses SNMP v2c. |
notifications.emailAddress |
string | The email address to which to send notification. For
notifications of type EMAIL . |
notifications.notificationToken |
string | A HipChat API token. For notifications of type HIP_CHAT .
If the token later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the token. |
notifications.roomName |
string | HipChat room name. For notifications of type HIP_CHAT . |
notifications.channelName |
string | The Slack channel name.For SLACK notifications. |
notifications.apiToken |
string | The Slack API token or Bot token. For SLACK notifications.
If the token later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the token. |
notifications.orgName |
string | The Flowdock organization name in lower-case letters. This is the
name that appears after www.flowdock.com/app/ in the URL
string. For FLOWDOCK notifications. |
notifications.flowName |
string | The flow name, in lower-case letters.For
|
notifications.flowdockApiToken |
string | The Flowdock “personal API token.” For FLOWDOCK
notifications. If the token later becomes invalid, Ops Manager sends an email
to the group owner and eventually removes the token. |
notifications.serviceKey |
string | PagerDuty service key. For PAGER_DUTY notifications.
If the key later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the key. |
metricThreshold |
object | The threshold that will cause an alert to be triggered. Required
if eventTypeName is set to OUTSIDE_METRIC_THRESHOLD . |
metricThreshold.metricName |
string | The name of the metric to check. Supports the same values as the
metricName field of the alerts resource. |
metricThreshold.operator |
string | The operator to apply when checking the current metric value against the threshold value. Possible values are:
|
metricThreshold.threshold |
number | The threshold value outside of which an alert will be triggered. |
metricThreshold.units |
string | The units for the threshold value. Depends on the type of metric. For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Possible values are:
|
metricThreshold.mode |
string | Set to AVERAGE to compute the current metric value as an average. |
threshold |
object | The threshold that will cause an alert to be triggered. Required
if
|
threshold.operator |
string | The operator to apply when checking the current metric value against the threshold value.
|
threshold.threshold |
number | The threshold value outside of which an alert will be triggered. |
Response Elements¶
The response includes the alert configuration details:
Note
Alert configurations vary. An alert configuration may only include a subset of these elements.
Name | Type | Description |
---|---|---|
id |
string | Unique identifier. |
groupId |
string | ID of the group that owns this alert configuration. |
eventTypeName |
string | The type of event that will trigger an alert.
|
typeName |
string | This field is deprecated and will be ignored. |
created |
date | When this alert configuration was created. |
updated |
date | When this alert configuration was last updated. |
enabled |
boolean | Is this alert configuration enabled? |
matchers |
object array | Rules to apply when matching an object against this alert configuration. Only entities that match all these rules will be checked for an alert condition. You can filter using the |
matchers.fieldName |
string | The name of the field in the target object to match on.
All other types of alerts do not support matchers. |
matchers.operator |
string | The operator to test the field’s value. Possible values are:
|
matchers.value |
string | The value to test with the specified operator. If
|
notifications |
object array | Notifications to send when an alert condition is detected. |
notifications.typeName |
string | The type of alert notification. Possible values are:
|
notifications.intervalMin |
number | The number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. |
notifications.delayMin |
number | The number of minutes to wait after an alert condition is detected before sending out the first notification. |
notifications.emailEnabled |
boolean | Should email notifications be sent? Only present for notifications of type
GROUP and USER . |
notifications.smsEnabled |
boolean | Should SMS notifications be sent? Only present for notifications of type
GROUP and USER . |
notifications.username |
string | The name of an Ops Manager user to which to send notifications. Only a user in the
group that owns the alert configuration is allowed here. Only present for
notifications of type USER . |
notifications.snmpAddress |
string | Hostname and port to send SNMP traps to. At this time
Ops Manager is only able to send SNMP traps to the standard SNMP
port (162). Only present for SNMP notifications. Ops Manager
uses SNMP v2c. |
notifications.emailAddress |
string | The email address to which to send notification. Only present for
notifications of type EMAIL . |
notifications.notificationToken |
string | A HipChat API token. Only present for notifications of type HIP_CHAT .
If the token later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the token. |
notifications.roomName |
string | HipChat room name. Only present for notifications of type HIP_CHAT . |
notifications.channelName |
string | The Slack channel name. Only present for SLACK notifications. |
notifications.apiToken |
string | The Slack API token or Bot token. Only present for SLACK notifications.
If the token later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the token. |
notifications.orgName |
string | The Flowdock organization name in lower-case letters. This is the
name that appears after www.flowdock.com/app/ in the URL
string. Only present for FLOWDOCK notifications. |
notifications.flowName |
string | The flow name, in lower-case letters. Only present for
|
notifications.flowdockApiToken |
string | The Flowdock “personal API token.” Only present for FLOWDOCK
notifications. If the token later becomes invalid, Ops Manager sends an email
to the group owner and eventually removes the token. |
notifications.serviceKey |
string | PagerDuty service key. Only present for PAGER_DUTY notifications.
If the key later becomes invalid, Ops Manager sends an email to the group
owner and eventually removes the key. |
metricThreshold |
object | The threshold that will cause an alert to be triggered. Only present
if eventTypeName is set to OUTSIDE_METRIC_THRESHOLD . |
metricThreshold.metricName |
string | The name of the metric to check. Supports the same values as the
metricName field of the alerts resource. |
metricThreshold.operator |
string | The operator to apply when checking the current metric value against the threshold value. Possible values are:
|
metricThreshold.threshold |
number | The threshold value outside of which an alert will be triggered. |
metricThreshold.units |
string | The units for the threshold value. Depends on the type of metric. For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Possible values are:
|
metricThreshold.mode |
string | This is set to AVERAGE and computes the current metric value as an average. |
threshold |
object | The threshold that will cause an alert to be triggered. Only present
if
|
threshold.operator |
string | The operator to apply when checking the current metric value against the threshold value.
|
threshold.threshold |
number | The threshold value outside of which an alert will be triggered. |