Schedule a snooze for the rule | Kibana API documentation

Schedule a snooze for the rule Generally available; added in 8.19.0

POST /api/alerting/rule/{id}/snooze_schedule

Spaces method and path for this operation:

post /s/{space_id}/api/alerting/rule/{id}/snooze_schedule

Refer to Spaces for more information.

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.

Headers

kbn-xsrf string Required

A required header to protect against CSRF attacks

Path parameters

id string Required

Identifier of the rule.

application/json

Body

schedule object Required

Additional properties are NOT allowed.
Hide schedule attribute Show schedule attribute object
- custom object
  
  Additional properties are NOT allowed.
  Hide custom attributes Show custom attributes object
  
  duration string Required
  
  The duration of the schedule. It allows values in <integer><unit> format. <unit> is one of d, h, m, or s for hours, minutes, seconds. For example: 1d, 5h, 30m, 5000s.
  
  Maximum length is 100.
  
  recurring object
  
  Additional properties are NOT allowed.
  
  Hide recurring attributes Show recurring attributes object
  
  end string
  
  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.
  
  Maximum length is 100.
  
  every string
  
  The interval and frequency of a recurring schedule. It allows values in <integer><unit> format. <unit> is one of d, w, M, or y for days, weeks, months, years. For example: 15d, 2w, 3m, 1y.
  
  Maximum length is 100.
  
  occurrences number
  
  The total number of recurrences of the schedule.
  
  Minimum value is 1.
  
  onMonth array[number]
  
  The specific months for a recurring schedule. Valid values are 1-12.
  
  At least 1 but not more than 12 elements. Minimum value of each is 1, maximum value of each is 12.
  
  onMonthDay array[number]
  
  The specific days of the month for a recurring schedule. Valid values are 1-31.
  
  At least 1 but not more than 31 elements. Minimum value of each is 1, maximum value of each is 31.
  
  onWeekDay array[string]
  
  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.
  
  At least 1 but not more than 77 elements. Maximum length of each is 10.
  
  start string Required
  
  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.
  
  Maximum length is 100.
  
  timezone string
  
  The timezone of the schedule. The default timezone is UTC.
  
  Maximum length is 64.

Responses

200 application/json

Indicates a successful call.
Hide response attribute Show response attribute object
- body object Required
  
  Additional properties are NOT allowed.
  
  Hide body attribute Show body attribute object
  
  schedule object Required
  
  Additional properties are NOT allowed.
  
  Hide schedule attributes Show schedule attributes object
  
  custom object
  
  Additional properties are NOT allowed.
  
  Hide custom attributes Show custom attributes object
  
  duration string Required
  
  The duration of the schedule. It allows values in <integer><unit> format. <unit> is one of d, h, m, or s for hours, minutes, seconds. For example: 1d, 5h, 30m, 5000s.
  
  Maximum length is 100.
  
  recurring object
  
  Additional properties are NOT allowed.
  
  Hide recurring attributes Show recurring attributes object
  
  end string
  
  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.
  
  Maximum length is 100.
  
  every string
  
  The interval and frequency of a recurring schedule. It allows values in <integer><unit> format. <unit> is one of d, w, M, or y for days, weeks, months, years. For example: 15d, 2w, 3m, 1y.
  
  Maximum length is 100.
  
  occurrences number
  
  The total number of recurrences of the schedule.
  
  Minimum value is 1.
  
  onMonth array[number]
  
  The specific months for a recurring schedule. Valid values are 1-12.
  
  At least 1 but not more than 12 elements. Minimum value of each is 1, maximum value of each is 12.
  
  onMonthDay array[number]
  
  The specific days of the month for a recurring schedule. Valid values are 1-31.
  
  At least 1 but not more than 31 elements. Minimum value of each is 1, maximum value of each is 31.
  
  onWeekDay array[string]
  
  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.
  
  At least 1 but not more than 77 elements. Maximum length of each is 10.
  
  start string Required
  
  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.
  
  Maximum length is 100.
  
  timezone string
  
  The timezone of the schedule. The default timezone is UTC.
  
  Maximum length is 64.
  
  id string Required
  
  Identifier of the snooze schedule.
400

Indicates an invalid schema.
403

Indicates that this call is forbidden.
404

Indicates a rule with the given id does not exist.

POST /api/alerting/rule/{id}/snooze_schedule

curl \
 --request POST 'https://localhost:5601/api/alerting/rule/{id}/snooze_schedule' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '"{\n  \"schedule\": {\n    \"custom\": {\n      \"duration\": \"8h\",\n      \"recurring\": {\n        \"every\": \"1w\",\n        \"occurrences\": 4,\n        \"onWeekDay\": [\n          \"MO\"\n        ]\n      },\n      \"start\": \"2025-03-17T09:00:00.000Z\",\n      \"timezone\": \"UTC\"\n    }\n  }\n}"'

Request examples

A request that snoozes a rule every Monday for 8 hours, for 4 occurrences.

{
  "schedule": {
    "custom": {
      "duration": "8h",
      "recurring": {
        "every": "1w",
        "occurrences": 4,
        "onWeekDay": [
          "MO"
        ]
      },
      "start": "2025-03-17T09:00:00.000Z",
      "timezone": "UTC"
    }
  }
}

A request that snoozes a rule for 24 hours starting now.

{
  "schedule": {
    "custom": {
      "duration": "24h",
      "start": "2025-03-12T12:00:00.000Z",
      "timezone": "UTC"
    }
  }
}

Response examples (200)

A response that contains the created snooze schedule.

{
  "schedule": {
    "custom": {
      "duration": "24h",
      "start": "2025-03-12T12:00:00.000Z",
      "timezone": "UTC"
    },
    "id": "9ac67950-6737-11ec-8ded-d7f6e1581b26"
  }
}