Retrieve Orchestrator alarms with filtering options

get

http://127.0.0.1:8080/alarm/gms

Returns a list of Orchestrator alarms based on the specified view type. Use 'active' for current alarms, 'closed' for historical/cleared alarms, or 'all' for both. Results can be filtered by severity and time range.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

view

string

enum

Defaults to all

Alarm state filter. 'active' returns current unresolved alarms, 'closed' returns historical cleared alarms, 'all' returns both active and closed alarms.

Allowed:

severity

string

enum

Filter alarms by severity level. When specified, only alarms matching the exact severity are returned. Case-insensitive.

Allowed:

maxAlarms

integer

1 to 100000

Defaults to 1000

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

from

int64

Start time boundary in milliseconds since Unix epoch (January 1, 1970 UTC). Only alarms occurring after this time are returned.

int64

End time boundary in milliseconds since Unix epoch. Only alarms occurring before this time are returned.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ or READ_WRITE role.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200Successfully retrieved list of Orchestrator alarms

400Bad request - Invalid parameter values