Schedule a snooze for the rule

Base URL: https://{kibana_url}

POST /api/alerting/rule/{id}/snooze_schedule
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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Responses

Indicates a successful call.

application/json

400

Indicates an invalid schema.

403

Indicates that this call is forbidden.

404

Indicates a rule with the given id does not exist.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

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

Console Kibana Dev Tools

POST kbn:/api/alerting/rule/ID/snooze_schedule
{
  "schedule": {
    "custom": {
      "duration": "8h",
      "recurring": {
        "every": "1w",
        "occurrences": 4,
        "onWeekDay": [
          "MO"
        ]
      },
      "start": "2025-03-17T09:00:00.000Z",
      "timezone": "UTC"
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/rule/${ID}/snooze_schedule" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule": {
      "custom": {
        "duration": "8h",
        "recurring": {
          "every": "1w",
          "occurrences": 4,
          "onWeekDay": [
            "MO"
          ]
        },
        "start": "2025-03-17T09:00:00.000Z",
        "timezone": "UTC"
      }
    }
  }'

Generated from the API spec

Response

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"
  }
}

Request Console 1 / 2 languages

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

Console Kibana Dev Tools

POST kbn:/api/alerting/rule/ID/snooze_schedule
{
  "schedule": {
    "custom": {
      "duration": "24h",
      "start": "2025-03-12T12:00:00.000Z",
      "timezone": "UTC"
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/rule/${ID}/snooze_schedule" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule": {
      "custom": {
        "duration": "24h",
        "start": "2025-03-12T12:00:00.000Z",
        "timezone": "UTC"
      }
    }
  }'

Generated from the API spec

Response

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"
  }
}

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body