List Active Channel Alarms

get /ui/connectors/channels-api/latest/channelalarms/active/

List active alarms for a channel identified by name.

Query parameters

channelName string Required

Response

200 Successful Response
valuelist of objectsAlarmRequired
Show 3 propertiesHide 3 properties
kindstringOptionalDefaults to Alarm
metadataobjectAlarmMetadataRequired
Show 6 propertiesHide 6 properties
idstringRequiredformat: uuid
namestringRequired
displayNameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

objectIdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

channelNamestringRequired
createdobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

statusobjectAlarmStatusRequired
Show 2 propertiesHide 2 properties
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
additionalInfoobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

supplementalobjectAlarmListSupplementalRequired
Show 4 propertiesHide 4 properties
kindstringOptionalDefaults to AlarmList
countintegerRequired
operationstringOptionalDefaults to list
paginationobjectPaginationRequired
Show 4 propertiesHide 4 properties
startintegerRequired
endintegerRequired
recordsintegerRequired
totalintegerRequired

Errors

422 Validation Error
detaillist of objectsValidationErrorOptional
Show 5 propertiesHide 5 properties
loclist of objectsRequired
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

integerinteger

Variant 2: integer

msgstringRequired
typestringRequired
inputanyOptional
ctxobjectOptional
503 Service unavailable

No response body.