Sign in
alerting

Schedule a snooze for the rule

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 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.

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

Path parameters

idstring required

Identifier of the rule.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

Response

Indicates a successful call.

Changes

Changed in 1 of the 100 revisions of this API.6

  • 43068c4185f96See the full diff
    • ●

      the schedule/custom/duration request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the schedule/custom/recurring/end request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the schedule/custom/recurring/every request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the schedule/custom/recurring/onWeekDay/items/ request property's maxLength was set to 10

      request-property-max-length-set

    • ●

      the schedule/custom/start request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the schedule/custom/timezone request property's maxLength was set to 64

      request-property-max-length-set