Schedule a backfill for rules

Base URL: https://{kibana_url}

POST /api/alerting/rules/backfill/_schedule

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>

Header parameters

Request body

Responses

Indicates a successful call.

application/json

An array; each item is any of:

created_at string required
duration string required
enabled boolean required
end string
id string required
initiator enum required: Values: user system
initiator_id string
rule object required
schedule object[] required
space_id string required
start string required
status enum required: Values: complete pending running error timeout

400

Indicates an invalid schema or parameters.

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

Console Kibana Dev Tools

POST kbn:/api/alerting/rules/backfill/_schedule
[
  {
    "ranges": [
      {
        "end": "2024-01-02T00:00:00.000Z",
        "start": "2024-01-01T00:00:00.000Z"
      }
    ],
    "rule_id": "3583a470-74f6-11ed-9801-35303b735aef"
  }
]

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/rules/backfill/_schedule" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "ranges": [
        {
          "end": "2024-01-02T00:00:00.000Z",
          "start": "2024-01-01T00:00:00.000Z"
        }
      ],
      "rule_id": "3583a470-74f6-11ed-9801-35303b735aef"
    }
  ]'

Generated from the API spec

Response

[
  {
    "created_at": "2024-01-30T00:00:00.000Z",
    "duration": "12h",
    "enabled": true,
    "id": "85bdf571-f4fb-4666-a8d2-e05e1220ebc6",
    "initiator": "user",
    "rule": {
      "api_key_owner": "elastic",
      "consumer": "alerts",
      "created_at": "2022-12-05T23:40:33.132Z",
      "created_by": "elastic",
      "enabled": true,
      "id": "3583a470-74f6-11ed-9801-35303b735aef",
      "name": "my alert",
      "params": {
        "aggField": "sheet.version",
        "aggType": "avg",
        "groupBy": "top",
        "index": [
          "test-index"
        ],
        "termField": "name.keyword",
        "termSize": 6,
        "threshold": [
          1000
        ],
        "thresholdComparator": "\u003E",
        "timeField": "@timestamp",
        "timeWindowSize": 5,
        "timeWindowUnit": "m"
      },
      "revision": 0,
      "rule_type_id": ".index-threshold",
      "schedule": {
        "interval": "1m"
      },
      "tags": [
        "cpu"
      ],
      "updated_at": "2022-12-05T23:40:33.132Z",
      "updated_by": "elastic"
    },
    "schedule": [
      {
        "interval": "12h",
        "run_at": "2024-01-01T12:00:00.000Z",
        "status": "pending"
      },
      {
        "interval": "12h",
        "run_at": "2024-01-02T00:00:00.000Z",
        "status": "pending"
      }
    ],
    "space_id": "default",
    "start": "2024-01-01T00:00:00.000Z",
    "status": "pending"
  }
]

Authentication

Header parameters

Request body [{ }]

Responses

Request body