Alerts API

This applies to: Visual Data Discovery

Alerts allow you to alert your end users when a metric reaches a specified threshold. Symphony API endpoints can be used to create, update, and delete alert definitions, each describing an alert condition, the schedule by which it is evaluated, and how notification is handled when the alert condition is met.

API support for alerting is performed using the REST API endpoint /api/alerts, as described below.

Endpoint	Method	Description
/api/alerts/{id}	GET	Returns a specific alert definition, identified by its ID. In a multi tenancy environment, respects Recipients rules.
/api/alerts/{id}	PUT	Updates a specific alert definition, identified by its ID. Completely replaces the previous version of the alert definition.
/api/alerts/{id}	DELETE	Deletes a specific alert definition, identified by its ID.
/api/alerts/{id}	PATCH	Patches a specific alert definition, identified by its ID.
/api/alerts	GET	Returns all alert definitions.
/api/alerts	POST	Creates a new alert. This endpoint requires the ROLE_CREATE_ALERT privilege.
/api/alerts/{id}/evaluate-condition	POST	Evaluates an alert condition in a specific alert definition.

API documentation is provided with your Symphony installation at this link: <symphony-URL>/discovery/swagger-ui.html.