List action policy executions
- Base URL
-
https://{kibana_url}
- GET /api/alerting/v2/execution_history/action_policies
- GET /s/{space_id}/api/alerting/v2/execution_history/action_policies
Get a paginated list of dispatcher summary events for action policies in the current space.
Required authorization
- Privileges read_alerting-v2-execution-history
Path parameters
-
space_idstringoptional -
An identifier for the space. If
space_idis not provided in the URL, the default space is used. Refer to Spaces for more information.
Query parameters
-
per_pageinteger · min: 1 · max: 100 · default: 20required -
Number of events per page. Defaults to 20.
-
fromstring · format: date-time · max length: 64 -
Inclusive ISO datetime lower bound on the event timestamp. Defaults to 24 hours before
to, or before the request whentois omitted. Independent of alert_ids — e.g. set it to an alert’s start time to scope results to that alert’s lifetime. -
tostring · format: date-time · max length: 64 -
Inclusive ISO datetime upper bound on the event timestamp.
-
alert_idsstring[] · min items: 1 · max items: 50 -
Alert filter. Narrows events to those referencing at least one of the provided alert IDs.
-
sort_fieldenum · default: dispatched_atrequired -
Sort field. Defaults to "dispatched_at".
-
Values:
dispatched_at -
searchstring · min length: 1 · max length: 256 -
Free-text search. Matches policy name, rule name, policy/rule ID (case-insensitive).
Responses
Returns a paginated list of execution history events.
-
itemsobject[]required -
alertsobject[] · max items: 50required -
Alert IDs referenced by this event, bounded to 50. Empty when the event references no alerts. Use
alert_countfor the true total. -
failure_reasonenum -
Values:
missing_api_keyworkflow_not_foundworkflow_disabledschedule_errorlicense_not_supported -
rule_countnumberrequired -
Number of rules referenced by this event after search or rule-filter narrowing. Unlike
totalon a list response, this is an exact count and it can exceedrules.lengthwhen the embedded array is truncated to the cap.
Indicates an invalid schema or parameters.
-
codestringrequired -
Stable error code you can branch on, for example
INVALID_SCHEDULEorRULE_ALREADY_EXISTS. -
detailsmap string to object -
Optional structured context whose keys depend on
code. Identifier keys such asrule_id,action_policy_idandgroup_hashare stable, permanent public identifiers. On a 400 request-validation error,details.source(params,query, orbody) names the failing part and is the only guaranteed key. The siblingdetails.errorsmay change. Do not branch on it.
Indicates the request was not authenticated.
-
codestringrequired -
Stable error code you can branch on, for example
INVALID_SCHEDULEorRULE_ALREADY_EXISTS. -
detailsmap string to object -
Optional structured context whose keys depend on
code. Identifier keys such asrule_id,action_policy_idandgroup_hashare stable, permanent public identifiers. On a 400 request-validation error,details.source(params,query, orbody) names the failing part and is the only guaranteed key. The siblingdetails.errorsmay change. Do not branch on it.
Indicates the user does not have the required privileges to perform the request.
-
codestringrequired -
Stable error code you can branch on, for example
INVALID_SCHEDULEorRULE_ALREADY_EXISTS. -
detailsmap string to object -
Optional structured context whose keys depend on
code. Identifier keys such asrule_id,action_policy_idandgroup_hashare stable, permanent public identifiers. On a 400 request-validation error,details.source(params,query, orbody) names the failing part and is the only guaranteed key. The siblingdetails.errorsmay change. Do not branch on it.
Indicates an unexpected server-side error.
-
codestringrequired -
Stable error code you can branch on, for example
INVALID_SCHEDULEorRULE_ALREADY_EXISTS. -
detailsmap string to object -
Optional structured context whose keys depend on
code. Identifier keys such asrule_id,action_policy_idandgroup_hashare stable, permanent public identifiers. On a 400 request-validation error,details.source(params,query, orbody) names the failing part and is the only guaranteed key. The siblingdetails.errorsmay change. Do not branch on it.
Indicates the alerting engine is disabled by the alerting:v2:enabled advanced setting.
-
codestringrequired -
Stable error code you can branch on, for example
INVALID_SCHEDULEorRULE_ALREADY_EXISTS. -
detailsmap string to object -
Optional structured context whose keys depend on
code. Identifier keys such asrule_id,action_policy_idandgroup_hashare stable, permanent public identifiers. On a 400 request-validation error,details.source(params,query, orbody) names the failing part and is the only guaranteed key. The siblingdetails.errorsmay change. Do not branch on it.