Create an alert

deprecated

Server: https://{kibana_url}

Refer to Spaces for more information.

Deprecated in 7.13.0. Use the create rule API instead.

Path Parameters

alertId string required: An UUID v1 or v4 identifier for the alert. If this parameter is omitted, the identifier is randomly generated.

actions [] object
alertTypeId string required: The ID of the alert type that you want to call when the alert is scheduled to run.
consumer string required: 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.
enabled boolean: Indicates if you want to run the alert on an interval basis after it is created.
name string required: A name to reference and search.
notifyWhen enum required: The condition for throttling the notification.; Values: onActionGroupChange onActiveAlert onThrottleInterval
params object required: The parameters to pass to the alert type executor params value. This will also validate against the alert type params validator, if defined.
schedule object required: 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.
tags [] string: A list of keywords to reference and search.
throttle string: 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 10m or 1h will prevent it from sending 90 notifications during this period.

Indicates a successful call.

application/json

Authorization information is missing or invalid.

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/alerts/alert/{alertId}

curl Shell

curl -X POST "https://{kibana_url}/api/alerts/alert/{alertId}" \
  -H "kbn-xsrf: true"

Response

No example