API Guide

2. ALERTS
Alerts generated in the NFC
2.1 GET /alerts
Returns all active alerts.
This API returns all the active alerts generated within NFC. An alert is raised when an instance of an event type occurs with
certain severity level. An alert is cleared when an instance of an event type occurs with certain severity level. For example -
CPU usage crossing a threshold 'X' will raise HIGH_CPU_USAGE_ALERT and CPU usage below a threshold 'X' will clear
HIGH_CPU_USAGE_ALERT.
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION
type string
Get all the active alerts based on alert type generated within NFC. An
example of Alert type is INTERFACE_LINK_DOWN_ALERT.
severity array of string
ALLOWED: INFO,
WARNING, ERROR,
CRITICAL, CLEARED
Get all the active alerts based on alert severity generated within NFC.
The Alert Severity can be - WARNING, ERROR or CRITICAL.
referenced-
object-id
string
Get all the active alerts generated on the referenced object id. The
referenced object id is the unique identier of the NFC managed object.
start-time int64
Get all the active alerts modied after start timestamp(inclusive). The
default value for start timestamp is set as (end-time - 24 hours). The
timestamp value is dened in milliseconds since epoch.
end-time int64
Get all the active alerts modied before end timestamp(inclusive). The
default value for end timestamp is set as current time. The timestamp
value is dened in milliseconds since epoch.
state array of string
ALLOWED: OPEN, ACK,
CLEARED
Get all the active alerts based on alert state generated within NFC. The
Alert states can be - OPEN, ACK or CLEARED.
information string
Get all the active alerts containing the specied string in the alert
information.
sort-by enum
ALLOWED: CREATED_AT,
UPDATED_AT
Field by which result needs to be sorted
sort-order enum
ALLOWED: ASC, DESC
Sort order
RESPONSE
STATUS CODE - 200: Response to get all the active alerts
RESPONSE MODEL - application/json
{
Get all the active nfc alerts
data [{
Array of object: Nfc alert object
id string
Unique identier of the nfc alert object
type string
Type of alert generated. Ex: INTERFACE_LINK_DOWN_ALERT
severity enum ALLOWED:INFO, WARNING, ERROR, CRITICAL, CLEARED
11 of 340