Update an alert Deprecated
Deprecated in 7.13.0. Use the update rule API instead.
Path parameters
-
The identifier for the alert.
Body Required
-
actions array[object]
-
A name to reference and search.
-
The condition for throttling the notification.
Values are
onActionGroupChange
,onActiveAlert
, oronThrottleInterval
. -
The parameters to pass to the alert type executor
params
value. This will also validate against the alert type params validator, if defined. -
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.
-
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
or1h
will prevent it from sending 90 notifications during this period.
curl \
-X PUT https://localhost:5601/api/alerts/alert/41893910-6bca-11eb-9e0d-85d233e3ee35 \
-H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
-H "kbn-xsrf: string"
# Headers
kbn-xsrf: string
# Payload
{
"actions": [
{
"actionTypeId": "string",
"group": "string",
"id": "string",
"params": {}
}
],
"name": "string",
"notifyWhen": "onActionGroupChange",
"params": {},
"schedule": {
"interval": "1d"
},
"tags": [
"string"
],
"throttle": "string"
}
{
"actions": [
{}
],
"alertTypeId": ".index-threshold",
"apiKeyOwner": "elastic",
"createdAt": "2022-12-05T23:36:58.284Z",
"createdBy": "elastic",
"enabled": true,
"executionStatus": {
"lastExecutionDate": "2022-12-06T00:13:43.890Z",
"status": "ok"
},
"id": "b530fed0-74f5-11ed-9801-35303b735aef",
"muteAll": false,
"mutedInstanceIds": [
"string"
],
"name": "my alert",
"notifyWhen": "onActionGroupChange",
"params": {},
"schedule": {
"interval": "string"
},
"scheduledTaskId": "b530fed0-74f5-11ed-9801-35303b735aef",
"tags": [
"string"
],
"throttle": "string",
"updatedAt": "2022-12-05T23:36:58.284Z",
"updatedBy": "elastic"
}
{
"error": "Unauthorized",
"message": "string",
"statusCode": 401
}