Create an Alert Definition - Alerts API

This applies to: Visual Data Discovery

Use alerts to alert yourself and other users when a metric reaches a specified threshold. Use the Symphony alerts endpoints to create alert definitions. These definitions describe an alert condition, determine a schedule to evaluate the alert condition, and how notifications are handled when an alert condition is met. See Create an Alert Definition to create alerts using the Symphony UI.

Use the endpoint /api/alerts to manage (list, create, update, and delete) alert definitions.

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.