Methods
Response
Unique name of the notification policy.
Possible values: length ≥ 1
Description of the notification policy.
Possible values: length ≥ 0
True if this notification policy is enabled and thus eligible to be matched to alerts.
URI to fetch the policy.
Status Code
Successful request
Invalid request
Unauthorized
Not authorized
[ { "name": "MyPolicy", "description": "This is a test policy.", "enabled": true, "policyURI": "https://localhost:3001/api/policies/v1/MyPolicy" }, { "name": "Sample Notification Policy", "description": "Sample notification policy that sends notifications for all incoming alerts", "enabled": false, "policyURI": "https://localhost:3001/api/policies/v1/Sample%20Notification%20Policy" } ]
Request
Custom Headers
Allowable values: [
application/json
,text/plain
]
Notification policy payload
Unique name of the notification policy.
Possible values: length ≥ 1
List of rules used to match alerts to the policy.
Possible values: number of items ≥ 0
True if this notification policy is enabled and thus will be considered when matching alerts.
Default:
false
Description of the notification policy.
Possible values: length ≥ 0
Default:
Your policy description
True if all rules must match the alert. False if any one or more of the rules must match the alert.
Default:
true
Number of identical alerts that must be received within the period of seconds defined by Within.
Possible values: value ≥ 1
Number of seconds that define the period in which the specified number of identical alerts (Until) must be received.
delayNotifications
List of users to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
Default:
["myuser@myco.com"]
List of groups to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
Default:
["MyGroup"]
List of channels to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
List of webhooks to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
Default:
["MyWebhook"]
Notify the recipients every time an alert matches or only the first time in an 8 hour period.
Allowable values: [
EveryMatch
,FirstIn8Hours
]Possible values: length ≥ 1
Default:
EveryMatch
Define escalations for when the alert is not acknowledged within a defined period.
Possible values: number of items ≥ 0
Possible values: number of items ≥ 0
Application Performance Management managed system group or resource name
Possible values: length ≥ 1
Reserved for future use
Request
Custom Headers
Allowable values: [
application/json
,text/plain
]
Path Parameters
Policy name
Notification policy payload
Unique name of the notification policy.
Possible values: length ≥ 1
List of rules used to match alerts to the policy.
Possible values: number of items ≥ 0
True if this notification policy is enabled and thus will be considered when matching alerts.
Default:
false
Description of the notification policy.
Possible values: length ≥ 0
Default:
Your policy description
True if all rules must match the alert. False if any one or more of the rules must match the alert.
Default:
true
Number of identical alerts that must be received within the period of seconds defined by Within.
Possible values: value ≥ 1
Number of seconds that define the period in which the specified number of identical alerts (Until) must be received.
delayNotifications
List of users to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
Default:
["myuser@myco.com"]
List of groups to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
Default:
["MyGroup"]
List of channels to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
List of webhooks to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
Default:
["MyWebhook"]
Notify the recipients every time an alert matches or only the first time in an 8 hour period.
Allowable values: [
EveryMatch
,FirstIn8Hours
]Possible values: length ≥ 1
Default:
EveryMatch
Define escalations for when the alert is not acknowledged within a defined period.
Possible values: number of items ≥ 0
Possible values: number of items ≥ 0
Application Performance Management managed system group or resource name
Possible values: length ≥ 1
Reserved for future use
Response
Unique name of the notification policy.
Possible values: length ≥ 1
List of rules used to match alerts to the policy.
Possible values: number of items ≥ 0
True if this notification policy is enabled and thus will be considered when matching alerts.
Description of the notification policy.
Possible values: length ≥ 0
True if all rules must match the alert. False if any one or more of the rules must match the alert.
Number of identical alerts that must be received within the period of seconds defined by Within.
Number of seconds that define the period in which the specified number of identical alerts (Until) must be received.
delayNotifications
List of users to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
List of groups to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
List of channels to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
List of webhooks to be notified when an alert satisfies the policy specifications.
Possible values: number of items ≥ 0, contains only unique items
Notify the recipients every time an alert matches or only the first time in an 8 hour period.
Possible values: [
EveryMatch
,FirstIn8Hours
]Possible values: length ≥ 1
Define escalations for when the alert is not acknowledged within a defined period.
Possible values: number of items ≥ 0
Possible values: number of items ≥ 0
Application Performance Management managed system group or resource name
Possible values: length ≥ 1
Status Code
Successful request
Unauthorized
Not authorized
Unable to locate policy
{ "enabled": true, "name": "MyPolicy", "description": "This is a test policy.", "users": [ "myuser@myco.com" ], "groups": [ "MyGroup" ], "channels": [ { "type": "Slack", "name": "General" } ], "webhooks": [ "MyWebhook" ], "rules": [ { "description": "My Custom Rule", "inputs": { "attribute": "What", "operator": "CONTAINS", "value": "Failure" } } ], "matchAllRules": true, "delayNotifications": { "until": 3, "within": 60 }, "notifyWhen": "EveryMatch", "escalations": [ { "waitFor": 20, "timeUnits": "minutes", "users": [ "myboss@myco.com" ], "groups": [ "MyBosses" ], "channels": [ { "type": "Slack", "name": "General" } ], "webhooks": [ "MyEscalationWebhook" ] } ], "notificationExceptions": [ { "rules": [ { "description": "My Custom Rule", "inputs": { "attribute": "What", "operator": "CONTAINS", "value": "Failure" } } ], "matchAllRules": true, "notifyBy": [ "email" ] } ] }
addUsers
Add one or more users as recipients for the specified notification policy
POST /policies/v1/{name}/users
removeUsers
Remove one or more users as recipients for the specified notification policy
DELETE /policies/v1/{name}/users
addGroups
Add one or more groups as recipients for the specified notification policy
POST /policies/v1/{name}/groups
removeGroups
Remove one or more groups as recipients for the specified notification policy
DELETE /policies/v1/{name}/groups