Read rule

GET 
/rules/:id

Read rule.

Authorization Action:

ruleengine:rules:get

Request

Path Parameters

id stringrequired

Responses

200

application/json

Schema

Schema

conditions object[]required
Array [
params objectrequired
oneOf
ThresholdConditionParamsDto
metric stringrequired
URN of the metric to be monitored
threshold numberrequired
comparisonOperator stringrequired
Possible values: [>, >=, <, <=, ==, !=]
unit string
durationSecs numberrequired
Possible values: <= 86400
activeWindow object
from stringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
to stringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
timezone stringrequired
IANA timezone identifier
LastMessageOlderThanConditionParamsDto
channelId stringrequired
durationSecs numberrequired
Possible values: <= 86400
activeWindow object
from stringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
to stringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
timezone stringrequired
IANA timezone identifier
DeltaConditionParamsDto
delta numberrequired
metric stringrequired
URN of the metric to be monitored
comparisonOperator stringrequired
Possible values: [>, >=, <, <=, ==, !=]
unit string
durationSecs numberrequired
Possible values: <= 86400
activeWindow object
from stringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
to stringrequired
Possible values: Value must match regular expression /^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$/
timezone stringrequired
IANA timezone identifier
status stringrequired
Possible values: [active, inactive]
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
type stringrequired
Possible values: [threshold, lastMessageOlderThan, delta]
id stringrequired
]
tags object[]required
Array [
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
label stringrequired
labelValue stringrequired
metadata object
Other custom properties associated to the tag
id stringrequired
]
status stringrequired

Possible values: [active, inactive]

createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
name stringrequired
severity string

Possible values: [info, warning, critical]

description string
processable string

Possible values: [enabled, disabled]

Default value: enabled

notification objectrequired
messages object[]required
Array [
target string
Notification target: can be an email address, a phone number or a telegram account. If not specified, the notification target is set to the user that created the rule.
policy stringrequired
Possible values: [trigger, reentry]
medium stringrequired
Possible values: [email, telegram, sms, slack, discord, fcm, msteams]
text stringrequired
]
id stringrequired

Example (from schema)

{
  "conditions": [
    {
      "params": {},
      "status": "active",
      "createdAt": "2024-08-30T08:48:05.880Z",
      "updatedAt": "2024-08-30T08:48:05.880Z",
      "deletedAt": "2024-08-30T08:48:05.880Z",
      "type": "threshold",
      "id": "string"
    }
  ],
  "tags": [
    {
      "createdAt": "2024-08-30T08:48:05.880Z",
      "updatedAt": "2024-08-30T08:48:05.880Z",
      "deletedAt": "2024-08-30T08:48:05.880Z",
      "label": "string",
      "labelValue": "string",
      "metadata": {},
      "id": "string"
    }
  ],
  "status": "active",
  "createdAt": "2024-08-30T08:48:05.880Z",
  "updatedAt": "2024-08-30T08:48:05.880Z",
  "deletedAt": "2024-08-30T08:48:05.880Z",
  "name": "string",
  "severity": "info",
  "description": "string",
  "processable": "enabled",
  "notification": {
    "messages": [
      {
        "target": "string",
        "policy": "trigger",
        "medium": "email",
        "text": "string"
      }
    ]
  },
  "id": "string"
}

404

Loading...