LIST Rules

GET 
/workspaces/:workspaceId/alerting/rules

LIST Rules

Request

Path Parameters

workspaceId uuidrequired

Query Parameters

deviceId string
streamName string
streamGroupName string

Responses

200

List of rules

application/json

Schema

Schema

• Array [

name string
deviceId stringnullable
streamName string
streamGroupName string
inactivityTimeout [d.]hh:mm:ss[.fffffff]

If a device does not send data for a specified period of time the alert is raised and sent to target(s).

targets string[]
createdTime date-time

Date and time the rule was created.

• ]

Example (from schema)

[
  {
    "name": "string",
    "deviceId": "string",
    "streamName": "string",
    "streamGroupName": "string",
    "inactivityTimeout": "1.12:34:00",
    "targets": [
      "string"
    ],
    "createdTime": "2024-12-17T17:37:35.223Z"
  }
]

example-1

[
  {
    "name": "my-rule",
    "deviceId": "my-device",
    "streamName": "my-stream",
    "streamGroupName": "my-stream-group",
    "siteId": "my-site",
    "inactivityTimeout": "00:30:00",
    "targets": [
      "slack-target",
      "service-bus-target"
    ],
    "createdTime": "2020-01-01T12:00:00+00:00"
  }
]

Loading...