Schedule a snooze for the rule
https://{kibana_url}
- POST /api/alerting/rule/{id}/snooze_schedule
When you snooze a rule, the rule checks continue to run but alerts will not generate actions. You can snooze for a specified period of time and schedule single or recurring downtimes.
Path Parameters
-
idstringrequired -
Identifier of the rule.
Request
-
scheduleobjectrequired -
custom -
durationstring · max: 100required -
The duration of the schedule. It allows values in
<integer><unit>format.<unit>is one ofd,h,m, orsfor hours, minutes, seconds. For example:1d,5h,30m,5000s. -
recurringobject -
endstring · max: 100 -
The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example:
2025-04-01T00:00:00.000Z. -
everystring · max: 100 -
The interval and frequency of a recurring schedule. It allows values in
<integer><unit>format.<unit>is one ofd,w,M, oryfor days, weeks, months, years. For example:15d,2w,3m,1y. -
occurrencesnumber · min: 1 -
The total number of recurrences of the schedule.
-
onMonthnumber · min: 1 · max: 12 -
The specific months for a recurring schedule. Valid values are 1-12.
-
onMonthDaynumber · min: 1 · max: 31 -
The specific days of the month for a recurring schedule. Valid values are 1-31.
-
onWeekDaystring · min: 1 · max: 77 -
The specific days of the week (
[MO,TU,WE,TH,FR,SA,SU]) or nth day of month ([+1MO, -3FR, +2WE, -4SA, -5SU]) for a recurring schedule. -
startstring · max: 100required -
The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example:
2025-03-12T12:00:00.000Z. -
timezonestring · max: 64 -
The timezone of the schedule. The default timezone is UTC.