create-alert-policy.md

{{{ "title": "Create Alert Policy", "date": "03-25-2015", "author": "Bryan Friedman", "attachments": [] }}}

Creates an alert policy in a given account. Calls to this operation must include a token acquired from the authentication endpoint. See the Login API for information on acquiring this token.

When to Use It

Use this API operation when you want to create a new alert policy within a given account.

URL

Structure

POST https://api.ctl.io/v2/alertPolicies/{accountAlias}

Example

POST https://api.ctl.io/v2/alertPolicies/ALIAS

Request

URI Parameters

Name	Type	Description	Req.
AccountAlias	string	Short code for a particular account	Yes

Content Properties

Name	Type	Description	Req.
name	string	Name of the alert policy.	Yes
actions	array	The actions to perform when the alert is triggered.	Yes
triggers	array	The definition of the triggers that fire the alert.	Yes

Actions Entity

Name	Type	Description
action	string	The only action currently supported by alerts is email.
settings	complex	The only setting currently supported is the recipients list, which is an array of email addresses to be notified when the alert is triggered.

Triggers Entity

Name	Type	Description
metric	string	The metric on which to measure the condition that will trigger the alert: cpu, memory, or disk.
duration	string	The length of time in minutes that the condition must exceed the threshold: 00:05:00, 00:10:00, 00:15:00.
threshold	number	The threshold that will trigger the alert when the metric equals or exceeds it. This number represents a percentage and must be a value between 5.0 - 95.0 that is a multiple of 5.0.

Examples

JSON

{
  "name":"Disk Above 80%",
  "actions":[
    {
      "action":"email",
      "settings":{
        "recipients":[
          "user@company.com"
        ]
      }
    }
  ],
  "triggers":[
    {
      "metric":"disk",
      "duration":"00:05:00",
      "threshold":80.0
    }
  ]
}

Response

Entity Definition

Name	Type	Description
id	string	ID of the alert policy.
name	string	Name of the alert policy.
actions	array	The actions to perform when the alert is triggered.
triggers	array	The definition of the triggers that fire the alert.
links	array	Collection of [entity links](../Getting Started/api-v20-links-framework.md) that point to resources related to this policy.

Examples

JSON

{
  "id" : "6fbe6ba659424b738e1134ab3be7b4b4",
  "name" : "Disk Above 80%",
  "actions" : [
    {
      "action" : "email",
      "settings" : {
        "recipients" : [
          "user@company.com"
        ]
      }
    }
  ],
  "links" : [
    {
      "rel" : "self",
      "href" : "/v2/alertPolicies/ALIAS/6fbe6ba659424b738e1134ab3be7b4b4",
      "verbs" : [
        "GET",
        "DELETE",
        "PUT"
      ]
    }
  ],
  "triggers" : [
    {
      "metric" : "disk",
      "duration" : "00:05:00",
      "threshold" : 80.0
    }
  ]
}