List Active Channel Alarms

get/api/channel-channelalarms/active/

List active alarms for a channel identified by name.

Query parameters

channelNamestringRequired

Response

200Successful Response

Loading schema details…

Errors

422Validation Error

Loading schema details…

503Service unavailable

No response body.

get/api/channel-channelalarms/active/

curl -X GET "/api/channel-channelalarms/active/"

200Successful Response

{
  "value": [
    {
      "kind": "Alarm",
      "metadata": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "displayName": "string",
        "objectId": "string",
        "channelName": "string",
        "created": "2024-01-01T00:00:00Z"
      },
      "status": {
        "severity": "Critical",
        "additionalInfo": "string"
      }
    }
  ],
  "supplemental": {
    "kind": "AlarmList",
    "count": 0,
    "operation": "list",
    "pagination": {
      "start": 0,
      "end": 0,
      "records": 0,
      "total": 0
    }
  }
}