4 RESTful API Alert Service

Important Oracle ZFS Storage Appliance events, such as hardware and software faults, trigger alerts. Alerts appear in the logs and can also be configured to perform other alert actions such as send an email or resume a dataset.

The RESTful API alert service enables you to create custom alert actions (responses to event alerts) and custom Analytics statistics threshold alerts.

Alert Service Commands

The following table shows the alert service commands. More than one alert action (response) can be defined for a single alert event. For example, you can send email to two different groups, write a syslog message, and resume a dataset all in response to a single alert. An actions-### object is the set of alert events and all responses to the alert. An action-### object is one of the responses.

Table 4-1 Alert Service Commands

Request	Append to Path /api/alert/v{1|2}	Description
GET	Use only /api/alert/v{1|2}	List the alert service commands
GET	/actions	List all alert actions objects
POST	/actions	Create a new alert action
GET	/actions/actions-###	List the specified alert actions properties
PUT	/actions/actions-###	Modify the specified alert actions object
DELETE	/actions/actions-###	Destroy the specified actions object
POST	/actions/actions-###	Create a new alert actions action
GET	/actions/actions-###/action-###	List the specified alert actions action properties
PUT	/actions/actions-###/action-###	Modify the specified alert actions action object
POST	/postalert	Posts a custom alert
DELETE	/actions/actions-###/action-###	Destroy the specified alert actions action object
GET	/thresholds	List all threshold alert objects
POST	/thresholds	Create a new threshold alert
GET	/thresholds/threshold-alert-uuid	List the specified threshold alert properties
PUT	/thresholds/threshold-alert-uuid	Modify the specified threshold alert object
DELETE	/thresholds/threshold-alert-uuid	Destroy the specified threshold alert object
GET	/events	Listen for new alert events