HomeGuidesAPI Reference
API Reference

Retrieve correlated root cause alarms

Returns a list of correlated root cause alarms based on the specified view (active or closed/historical). Root cause analysis correlates multiple alarms to identify underlying issues such as interface failures, tunnel outages, or ISP connectivity problems.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to active

Filter alarms by status. Use 'active' for current unresolved alarms, or 'closed' for historical/resolved alarms.

Allowed:
integer
≥ 1
Defaults to 1000

Maximum number of alarms to return. Limits result set size for performance.

int64

Start time boundary in milliseconds since EPOCH (Unix timestamp). Filters alarms that occurred after this time.

int64

End time boundary in milliseconds since EPOCH (Unix timestamp). Filters alarms that occurred before this time.

Responses

401

Unauthorized - Authentication required. User must have READ or READ_WRITE role.

403

Forbidden - User lacks required permissions (READ or READ_WRITE role required).

500

Internal server error - Failed to retrieve alarms from database.

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