Skip to content

Get device fault and alarm list

GET
/devices/{deviceId}/alarms

Return device fault and alarm records within a 30-day time range.

Authorizations

AccessToken
Type
HTTP (bearer)

Parameters

Path Parameters

deviceId*

Device ID

Type
string
Required

Query Parameters

alarmLevel

Alarm type: Fault, Alarm, Notice

Type
string
Valid values
"fault""alarm""notice"
status

Alarm status: Active, Resolved

Type
string
Valid values
"active""resolved"
startTime

Start time (ISO 8601 format, UTC)

Type
string
Format
"date-time"
endTime

End time (ISO 8601 format, UTC)

Type
string
Format
"date-time"
page

Page number

Type
integer
Default
1
Minimum
1
size

Items per page

Type
integer
Default
20
Minimum
1
Maximum
500

Responses

Alarm list returned successfully

application/json
object

Device ID

Total alarm count

Current page number

Items per page

object[]

Alarm list

Playground

Authorization
Variables
Key
Value