EAeagleeyenetworks
Event Alert Rules

PATCH /eventAlertConditionRules/{id}

Updates the properties of a specific rule. Only the user defined fields can be updated by this method.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/eventAlertConditionRules/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Id

Request body

namestring

Name for the rule

priorityinteger

Defines the priority of the alert

notesstring

A verbose explanation of the rule

enabledboolean

Whether rule is enabled

cooldownSecondsinteger

Cooldown period (in seconds). If two events for the same actor and event type have event timestamps within this duration, only the first will trigger an alert while the second event will be suppressed. A value of 0 disables the cooldown checks.

Example request

{
  "name": "Alert on Motion detection",
  "notes": "Generate alerts on Motion Detection at night.",
  "humanValidation": {
    "enabled": true,
    "service": "eenV1"
  },
  "eventFilter": {
    "eventTypes": [
      "een.lprPlateReadEvent.v1"
    ],
    "data": {
      "and": [
        {
          "een.lprDetection.v1.plateConfidence__gte": 0.95,
          "een.lprDetection.v1.plateRegion__in": [
            "US-NY",
            "CA-ON"
          ]
        }
      ]
    },
    "resourceFilter": {
      "actors": [
        "camera:100d4c41",
        "camera:*"
      ]
    }
  }
}

Response

The rule is updated successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.