Create an alert
- Base URL
-
https://{kibana_url}
Refer to Spaces for more information.
Deprecated in 7.13.0. Use the create rule API instead.
Request body
-
alertTypeIdstringrequired -
The ID of the alert type that you want to call when the alert is scheduled to run.
-
consumerstringrequired -
The name of the application that owns the alert. This name has to match the Kibana feature name, as that dictates the required role-based access control privileges.
-
notifyWhenrequired -
The condition for throttling the notification.
-
Values:
onActionGroupChangeonActiveAlertonThrottleInterval -
paramsobjectrequired -
The parameters to pass to the alert type executor
paramsvalue. This will also validate against the alert type params validator, if defined. -
scheduleobjectrequired -
The schedule specifying when this alert should be run. A schedule is structured such that the key specifies the format you wish to use and its value specifies the schedule.
-
A list of keywords to reference and search.
-
throttlestring -
How often this alert should fire the same actions. This will prevent the alert from sending out the same notification over and over. For example, if an alert with a schedule of 1 minute stays in a triggered state for 90 minutes, setting a throttle of
10mor1hwill prevent it from sending 90 notifications during this period.
Responses
Indicates a successful call.