GET Rule

GET 
/workspaces/:workspaceId/alerting/rules/:ruleName

GET Rule

Request

Path Parameters

workspaceId uuidrequired
ruleName stringrequired

Responses

200

Rule details

application/json

Schema

Schema

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-11-11T15:00:26.744Z"
}

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"
}

404

A rule was not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...