HomeGuidesAPI Reference
API Reference

Get alarm summary for an appliance within a time period

Retrieves a summary of alarms for a specific appliance within a time range. Returns the most recent alarm of each severity level (critical, major, minor, warning) along with counts of all alarms by severity. Both active and closed alarms that fall within the time range are included.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required

Start time in milliseconds since EPOCH. Defines the beginning of the time range for alarm queries.

int64
required

End time in milliseconds since EPOCH. Defines the end of the time range for alarm queries.

string
required

Unique identifier of the appliance (network element primary key). Used to filter alarms for a specific appliance.

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User does not have READ or READ_WRITE permissions

500

Internal Server Error - Database or service unavailable

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json