Alarms

Get an alarm by ID

get/api/v2/alarms/{alarmID}

Request

  • Base URL: https://gear.cloud.studio
  • URL: https://gear.cloud.studio/api/v2/alarms/{alarmID}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter accessToken

Path parameters

alarmIDinteger required

Unique identifier of the alarm.

Response

The alarm.

AlarmIDinteger
DeviceIDinteger
EndpointIDinteger
AlarmTypeIDinteger
AlarmTypeDescriptionstring
AlarmSeverityID0 | 1 | 2 | 3

0 information, 1 low, 2 medium, 3 high.

AlarmSeverityDescriptionstring
Detailsstring
DateTimeCreated_UTCstring
DateTimeClosed_UTCstring
SequenceNumberinteger

Changes

No recorded changes to this operation across all 1 revision of this API.