Create a new alert

post https://{hostname}/alerts/v2/alert-definitions

Creates a new alert definition based on a template. The template's required fields represent criteria you may use to trigger an alert, but the new definition's fields specify the set of values that actually trigger the alert. After you create a new alert, it may take a couple of minutes before it has enough information before it can fire.

Responses

Response body

object

accountId

string

length ≥ 1

Identifies the account under which the alert was created.

definitionId

string

length ≥ 1

Identifies the alert definition.

editInfo

object

A summary of the alert's creation time and most recent edit.

active

boolean

required

When the alert origin is STATIC, indicates if the alert is allowed to fire. A false value may be due to variations in account and contract status that leaves the alert configured but inactive.

createdAt

date-time

required

ISO 8601 timestamp for when the alert was created.

createdBy

string

required

length ≥ 1

The user who created the alert.

editAt

date-time

required

ISO 8601 timestamp for when the alert was last edited.

editBy

string

required

length ≥ 1

The user who last edited the alert.

fields

object

required

The set of criteria that determines when the alert fires. The object's members vary depending on the template on which the alert is based. However, all fields include a name, the templateId on which the alert was based, and an array of email addresses for the alert's recipients.

array of strings

length ≥ 0

Email addresses of alert notification's recipients.

group

array of integers

length ≥ 1

Group identifiers to which alert should be assigned.

group

name

string

required

length ≥ 1

The human readable name for the alert.

templateId

string

required

length ≥ 1

Identifies the template.

links

array of objects

length ≥ 2

Link relations to schemas and REST endpoints.

links

object

href

string

required

length ≥ 1

Link to resource of type described by rel.

rel

string

required

length ≥ 1

Describes type of link.

origin

string

Identifies the type of alert the template enables, either STATIC or ADAPTIVE. Static alert types specify raw values, while the adaptive alert type expresses standard deviations. The only available ADAPTIVE alert identifies excessive traffic, and its templateId is a@1.

STATIC ADAPTIVE

xxxxxxxxxx
}
{
  "accountId": "A-CCT5678",
  "definitionId": "s@123",
  "editInfo": {
    "active": true,
    "createdAt": "2006-02-16T20:49:54Z",
    "createdBy": "hgildong",
    "editAt": "2006-02-16T20:49:54Z",
    "editBy": "szhang"
  },
  "fields": {
    "aca_cpcode": [
      "111",
      "33190"
    ],
    "alertLowerBound": 5,
    "definitionId": "s@123",
    "email": [
      "nomail@akamai.com"
    ],
    "emailBrief": [
      "12345678@akamai.com"
    ],
    "emailHtmlFormat": true,
    "isSum": true,

201The response provides the newly created alert.

400Bad request.

401Unauthorized error.

403Access is forbidden.

405Method not allowed.

415Unsupported media type.

500Server error.