HomeGuidesAPI Reference
API Reference

Retrieve appliance alarms for specified appliances

Returns active, historical, or all alarms for the appliances specified in the request body.

Response: Each alarm object includes severity, description, recommendedAction, source, type, timestamps, acknowledgement status, and more. See the ApplianceAlarmItem schema for full details.

Filtering: Use query parameters to filter by status (view), severity level, and time range (from/to). Results can be sorted by severity (orderBySeverity) and capped with maxAlarms.

Severity values: Response values are uppercase (WARNING, MINOR, MAJOR, CRITICAL), while the severity query parameter accepts lowercase (warning, minor, major, critical).

Correlation fields: The fields sourceIp, destinationIp, peerId, hierarchy, isRoot, instanceId, sourceLabel, destinationLabel, and saCount are always present in every alarm object, but only contain meaningful (non-default) values for correlation-engine alarm types: tunnel down, interface down, nexthop down, and IPSLA link down alarms. For all other alarm types, these fields contain default values (empty string for strings, false for booleans, 0 for numbers).

Obtaining nePk values: Appliance IDs (nePks) can be retrieved from GET /appliance. Each appliance object contains an id field in the format {number}.NE (e.g., 10.NE, 2094.NE).

Note on hostName: The hostName field is populated from the appliance's configured hostname. In rare cases during alarm creation, if the appliance is not in cache, it may be empty. Resolve via GET /appliance if needed.

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

Filter alarms by status. 'active' returns current unresolved alarms, 'closed' returns historical resolved alarms, 'all' returns both.

Allowed:
string
enum

Filter alarms by severity level. When specified, only alarms of this severity are returned. Case-insensitive.

Allowed:
boolean
Defaults to false

When true, results are sorted by severity level (critical first). Default is chronological order.

integer
1 to 100000
Defaults to 1000

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

int64

Start time boundary in milliseconds since EPOCH (Unix timestamp * 1000). Only alarms occurring after this time are returned.

int64

End time boundary in milliseconds since EPOCH (Unix timestamp * 1000). Only alarms occurring before this time are returned.

Body Params

List of appliance IDs (nePks) to retrieve alarms for. At least one appliance ID must be provided.

Request body containing the list of appliance IDs to query

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Responses

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