alerting

Schedule a snooze for the rule

Changed on

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

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/alerting/rule/{id}/snooze_schedule
  • Auth
    • API key in header Authorization
    • or HTTP basic

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

    • warning

      the // request property's maxLength was set to 100

    • warning

      the /// request property's maxLength was set to 100

    • warning

      the /// request property's maxLength was set to 100

    • warning

      the //// request property's maxLength was set to 10

    • warning

      the // request property's maxLength was set to 100

    • warning

      the // request property's maxLength was set to 64