get #

Gets an alert rule.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/alert-rules/:index/:_id
Method: GET

Javascript #

kuzzle.query({
  controller: 'alert-rules',
  action: 'get',
  index: '<index>',
  _id: '<alert rule id>',
});

Arguments #

Arguments	Type	Description
`index`	string	Tenant index
`_id`	string	Alert rule ID

Response #

Returns the alert rule.

{
  "status": 200,
  "action": "get",
  "controller": "alert-rules",
  "error": null,
  "headers": {},
  "index": "<index>",
  "node": "<node-id>",
  "requestId": "<request-id>",
  "result": {
    "_id": "<alert-rule-id>",
    "_source": {
      "type": "alert-rules",
      "alert-rules": {
        "name": "Temperature Alert",
        "description": "Alert triggered when temperature exceeds threshold",
        "linkedNotificationRules": [],
        "scope": {
          "collection": "measures",
          "filters": [
            {
              "model": "Device",
              "references": ["device-1"],
              "measureSlots": ["temperature"]
            }
          ]
        },
        "plannings": {
          "days": {
            "mon": true,
            "tue": true,
            "wed": true,
            "thu": true,
            "fri": true,
            "sat": true,
            "sun": true
          },
          "range": {
            "allDay": true,
            "start": "00:00",
            "end": "23:59"
          },
          "timezone": "UTC"
        },
        "rule": {
          "type": "threshold",
          "threshold": {
            "field": "values.temperature",
            "operator": "gt",
            "value": 25,
            "debounce": {
              "down": 5,
              "levels": [
                {
                  "delay": 1,
                  "severity": "warning"
                }
              ]
            }
          }
        }
      },
      "_kuzzle_info": {
        "author": "<author>",
        "createdAt": 1234567890123,
        "updatedAt": null,
        "updater": null
      }
    }
  }
}

Edit this page on Github