Type to search.

List action policy executions

Base URL
https://{kibana_url}
  • GET /api/alerting/v2/execution_history/action_policies
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Experimental since 9.5 This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Get a paginated list of dispatcher summary events for action policies in the current space.

Required privileges

Privileges read_alerting-v2-execution-history

Query parameters

page integer · min: 1 · max: 10000

Page number (1-indexed). Defaults to 1.

per_page integer · min: 0 · max: 100

Number of events per page. Defaults to 20. Pass 0 for a count-only read.

start_date string · format: date-time · pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Inclusive ISO datetime lower bound on the event timestamp; overrides the default 24-hour window. Independent of episode_ids — e.g. set it to an episode’s start time to scope results to that episode’s lifetime.

episode_ids string[] · min items: 1 · max items: 50

Episode filter. Narrows events to those referencing at least one of the provided episode ids.

Free-text search. Matches policy name, rule name, policy/rule ID (case-insensitive).

rule_ids string[] · min items: 1 · max items: 50

Explicit rule filter. Narrows events to those referencing at least one of the provided rule ids. Also unions with the search filter if both are provided.

outcome enum[] · min items: 1 · max items: 3

Outcome filter. When omitted matches all outcomes. Pass one or more of "dispatched", "throttled", "dispatch_failed" to narrow.

Values: dispatched throttled dispatch_failed

Responses

Returns a paginated list of execution history events.

application/json
items object[] required
action_group_count number required
dispatched_at string required
episode_count number required
failure_reason enum
Values: missing_api_key workflow_not_found workflow_disabled schedule_error
outcome enum required
Values: dispatched throttled dispatch_failed
policy object required
id string required
name string nullable
rules object[] · max items: 20 required

Rules referenced by this event, bounded to MAX_EMBEDDED_RULES_PER_ITEM. When a search or rule filter narrows the match, this array is intersected with the matched subset server-side. Use total_rule_count for the full count.

id string required
name string nullable
total_rule_count number required

Total number of rules referenced by this event after search / rule-filter narrowing. May exceed rules.length when the embedded array is truncated to the cap.

workflows object[] · max items: 100 required
id string required
name string nullable
page integer · min: 1 · max: 9007199254740991 required
per_page integer · min: 0 · max: 9007199254740991 required
search_matches object required nullable

Per-type match counts for the active search, plus the cap used as filter. Null when no search was provided. When policies > cap or rules > cap the result is truncated.

cap number required

Maximum number of policy/rule ids the server uses as a filter.

policies number required

Total policies matching the search.

rules number required

Total rules matching the search.

total_events integer · min: 0 · max: 9007199254740991 required