HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. alarm

Retrieve correlated alarms (active or historical)

get
http://127.0.0.1:8080/alarm/correlatedAlarms

Returns active or historical correlated alarms based on the view parameter. Correlated alarms include root cause information linking related network events.

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. 'active' returns current unresolved alarms; 'closed' returns historical resolved alarms.

Allowed:
string
enum

Filter alarms by severity level. When omitted, returns alarms of all severity levels.

Allowed:
integer
1 to 100000
Defaults to 1000

Maximum number of alarms to return. Must be between 1 and 100000.

int64

Start time boundary for filtering alarms. Value is milliseconds since UNIX epoch (January 1, 1970).

int64

End time boundary for filtering alarms. Value is milliseconds since UNIX epoch (January 1, 1970).

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ or READ_WRITE permission

Updated about 11 hours ago

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

Updated about 11 hours ago

Did this page help you?