Post alertactionrules — devices

Registers a new alert action rule with the account. These rules allow users to link alert action rules to alert condition rule.

Request body

idstring

Unique identifier of the alert action rule.

createTimestampstring date-time

Time at which the alert action rule was created.

namestring required

Name to let humans easily identify and understand the alert action rule.

notesstring

Large text field that allows users to leave notes for themselves and others.

enabledboolean

If set to true, this rule is active, if set to false, it will not be applied.

alertTypesstring[] nullable

If defined, this rule will only trigger on alerts of the given types.

actorIdsstring[] nullable

If defined, this rule will only trigger on alerts about actors with the given ids.

actorTypesstring[] nullable

If defined, this rule will only trigger on alerts about actors of the given types.

actorAccountIdsstring[] nullable

If defined, this rule will only trigger on alerts about actors from the given accounts.

ruleIdsstring[] nullable

If defined, this rule will only trigger on alerts that were generated by one of the given alert condition rules.

priority__gteinteger nullable

If defined, this rule will only trigger on alerts with a priority greater than or equal to the given value.

priority__lteinteger nullable

If defined, this rule will only trigger on alerts with a priority less than or equal to the given value.

alertActionIdsstring[] required

Defines the actions to take if an alert matches the rule.

locationIdsstring[] nullable

If defined, this rule will only trigger on alerts about actors from the given locations.

Example request

{
  "id": "322d38b9-8ed7-41b5-a57d-3fe9f160939c",
  "createTimestamp": "2021-04-22T00:00:00.000+00:00",
  "name": "Cameras offline for 5 min.",
  "notes": "Take action if cameras are offline for more than 5 minutes.",
  "enabled": true,
  "alertTypes": [
    "userLogin"
  ],
  "actorTypes": [
    "device"
  ],
  "ruleIds": [
    "d290f1ee-6c54-4b01-90e6-d701748f0851"
  ],
  "priority__gte": 3,
  "priority__lte": 8,
  "alertActionIds": [
    "f3436b61-94fd-41b6-8f0a-ee6ff55acaa6"
  ]
}

Response

Alert action rule registered.