Alarms (v1) - Retrieve Information About Alarms

Introduction

The Superna Eyeglass REST API - v1 Alarms provides endpoints to retrieve, manage, and monitor alarm states in Superna Eyeglass. This API allows you to view both active and historical alarms

Endpoints

GET /v1/alarms/active

Description: Returns all active alarms from Eyeglass.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
since	(optional)	Timestamp for filtering the active alarms newer than	query	long
until	(optional)	Timestamp for filtering the active alarms older than	query	long
limit	(optional)	Limits the number of returned alarms	query	long

Response Codes:

• 200 OK: Successfully retrieved active alarms.
• default: Error payload, see response structure.

Model:

[
  {
    "code": "string",
    "extra_data": "string",
    "message": "string",
    "severity": "string",
    "source": "string",
    "sync_group": "string",
    "sync_key": "string",
    "timestamp": 0
  }
]

Response Messages:

• default (Error)

  {
    "code": 0,
    "message": "string"
  }

GET /v1/alarms/historical

Description: Returns all historical alarms from Eyeglass.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
since	(optional)	Timestamp for filtering the active alarms newer than	query	long
until	(optional)	Timestamp for filtering the active alarms older than	query	long
limit	(optional)	Limits the number of returned alarms	query	long

Response Codes:

• 200 OK: Successfully retrieved historical alarms.
• default: Error payload, see response structure.

Model:

[
  {
    "code": "string",
    "extra_data": "string",
    "message": "string",
    "severity": "string",
    "source": "string",
    "sync_group": "string",
    "sync_key": "string",
    "timestamp": 0
  }
]

Response Messages:

• default (Error)

  {
    "code": 0,
    "message": "string"
  }