Update an alert

Base URL
https://{kibana_url}
Auth Deprecated

Deprecated in 7.13.0. Use the update rule API instead.

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

alertId string required

The identifier for the alert.

Example: 41893910-6bca-11eb-9e0d-85d233e3ee35

Header parameters

kbn-xsrf string required

Cross-site request forgery protection

Request body

actions object[]
actionTypeId string required

The identifier for the action type.

group string required

Grouping actions is recommended for escalations for different types of alert instances. If you don't need this functionality, set it to default.

id string required

The ID of the action saved object.

params object required

The map to the params that the action type will receive. params are handled as Mustache templates and passed a default set of context.

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.

interval string

The interval format specifies the interval in seconds, minutes, hours or days at which the alert should run.

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.

Responses

Indicates a successful call.

application/json
actions object[]
alertTypeId string
apiKeyOwner string nullable
createdAt string · format: date-time

The date and time that the alert was created.

createdBy string

The identifier for the user that created the alert.

enabled boolean

Indicates whether the alert is currently enabled.

executionStatus object
lastExecutionDate string · format: date-time
status string
id string

The identifier for the alert.

muteAll boolean
mutedInstanceIds string[] nullable
name string

The name of the alert.

notifyWhen string
params object
schedule object
interval string
scheduledTaskId string
tags string[]
throttle string nullable
updatedAt string
updatedBy string nullable

The identifier for the user that updated this alert most recently.

Authorization information is missing or invalid.

application/json
error enum
Values: Unauthorized
message string
statusCode enum
Values: 401
Base URL
https://{kibana_url}