---
title: "Schedule a snooze for the rule"
method: POST
path: "/api/alerting/rule/{id}/snooze_schedule"
tags: ["alerting"]
---

# Schedule a snooze for the rule

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

**Spaces method and path for this operation:**

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/alerting/rule/{id}/snooze_schedule</span></div>

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-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.

## Path parameters

- `id` string, required

## Headers

- `kbn-xsrf` string, required

## Request body

- object
  - `schedule` object, required
    - `custom` KibanaHTTPAPIsScheduleRequest
      - `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`.
      - `recurring` 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`.
        - `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`.
        - `occurrences` number — The total number of recurrences of the schedule.
        - `onMonth` number[] — The specific months for a recurring schedule. Valid values are 1-12.
        - `onMonthDay` number[] — The specific days of the month for a recurring schedule. Valid values are 1-31.
        - `onWeekDay` 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.
      - `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`.
      - `timezone` string — The timezone of the schedule. The default timezone is UTC.

## Response `200`

Indicates a successful call.

- object
  - `body` object, required
    - `schedule` object, required
      - `custom` KibanaHTTPAPIsScheduleRequest
        - `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`.
        - `recurring` 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`.
          - `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`.
          - `occurrences` number — The total number of recurrences of the schedule.
          - `onMonth` number[] — The specific months for a recurring schedule. Valid values are 1-12.
          - `onMonthDay` number[] — The specific days of the month for a recurring schedule. Valid values are 1-31.
          - `onWeekDay` 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.
        - `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`.
        - `timezone` string — The timezone of the schedule. The default timezone is UTC.
      - `id` string, required — Identifier of the snooze schedule.

## Other responses

- `400` — Indicates an invalid schema.
- `403` — Indicates that this call is forbidden.
- `404` — Indicates a rule with the given id does not exist.

---

[API](https://skmtc.net/elastic/apis/kibana-apis.md) · [All operations](https://skmtc.net/elastic/apis/kibana-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/kibana-apis/versions/531c9e2a7d23/schema)