GET Rule
GET/workspaces/:workspaceId/alerting/rules/:ruleName
GET Rule
Request
Path Parameters
workspaceId uuidrequired
ruleName stringrequired
Responses
- 200
- 404
Rule details
- application/json
- Schema
- Example (from schema)
- example-1
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.
{
"name": "string",
"deviceId": "string",
"streamName": "string",
"streamGroupName": "string",
"inactivityTimeout": "1.12:34:00",
"targets": [
"string"
],
"createdTime": "2024-12-06T09:29:03.975Z"
}
{
"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"
}
A rule was not found.
- application/problem+json
- Schema
- Example (from schema)
Schema
type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Loading...