API Guide

Alerts
Alerts generated in SFD.
Topics:
• GET /alerts
• POST /alerts/{id}/ack
• POST /alerts/{id}/unack
• POST /alerts/{id}/clear
• GET /alerts/{id}/events
GET /alerts
Retrieves alerts generated in SFD.
API
GET /alerts
Description
This API returns all active alerts that are generated within SFD. 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 raises HIGH_CPU_USAGE_ALERT, and CPU usage
below a threshold X clears HIGH_CPU_USAGE_ALERT.
Parameters
Table 2. API parameters
Filter name Description
type
string
(query)
Gets all active alerts based on the alert type that is
generated within SFD.
INTERFACE_LINK_DOWN_ALERT
severity
string
(query)
Gets all active alerts based on the alert severity that
is generated within SFD.
WARNING, ERROR or CRITICAL
referenced-object-id
string
(query)
Gets all active alerts generated on the referenced
object id. The referenced object id is the unique
identifier of the SFD-managed object.
start-time
integer (int64)
(query)
Gets all the active alerts that are created after the
start timestamp (inclusive). The default value for the
start timestamp is set as (end-time - 24 hours). The
timestamp value is defined in milliseconds since
epoch.
end-time
integer (int64)
(query)
Gets all active alerts that are created before the end
timestamp (inclusive). The default value for the end
timestamp is set as the current time. The timestamp
value is defined in milliseconds since epoch.
state
string
Gets all active alerts based on the alert state that is
generated within SFD. The alert state can be OPEN
or ACK.
4
Alerts 11