Get information about rules
https://{kibana_url}
- GET /api/alerting/rules/_find
- GET /s/{space_id}/api/alerting/rules/_find
Refer to Spaces for more information.
Query Parameters
-
per_pagenumber · min: 0 · default: 10 The number of rules to return per page.
-
pagenumber · min: 1 · default: 1 The page number to return.
-
searchstring An Elasticsearch simple_query_string query that filters the objects in the response.
-
default_search_operator· default: OR The default operator to use for the simple_query_string.
-
Values:
ORAND -
search_fieldsstring | string The fields to perform the simple_query_string parsed query against.
-
sort_fieldstring Determines which field is used to sort the results. The field must exist in the
attributeskey of the response.-
has_referenceobject Filters the rules that have a relation with the reference objects with a specific type and identifier.
-
fieldsstring | string The fields to return in the
attributeskey of the response.-
filterstring A KQL string that you filter with an attribute from your saved object. It should look like
savedObjectType.attributes.title: "myTitle". However, if you used a direct attribute of a saved object, such asupdatedAt, you must define your filter, for example,savedObjectType.updatedAt > 2018-12-22.-
filter_consumersstring
Responses
Indicates a successful call.
-
actionsobjectrequired -
alerts_filterobject -
Defines a period that limits whether the action runs.
-
queryobject -
timeframeobject -
days -
Defines the days of the week that the action can run, represented as an array of numbers. For example,
1represents Monday. An empty array is equivalent to specifying all the days of the week. -
Values:
1234567 -
hoursobjectrequired -
timezonestringrequired -
The ISO time zone for the
hoursvalues. Values such asUTCandUTC+1also work but lack built-in daylight savings time support and are not recommended. -
connector_type_idstringrequired -
The type of connector. This property appears in responses but cannot be set in requests.
-
frequencyobject -
notify_when -
Indicates how often alerts generate actions. Valid values include:
onActionGroupChange: Actions run when the alert status changes;onActiveAlert: Actions run when the alert becomes active and at each check interval while the rule conditions are met;onThrottleInterval: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: You cannot specifynotify_whenat both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values. -
Values:
onActionGroupChangeonActiveAlertonThrottleInterval -
summarybooleanrequired -
Indicates whether the action is a summary.
-
throttlestringrequired nullable -
The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if 'notify_when' is set to 'onThrottleInterval'. NOTE: You cannot specify the throttle interval at both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.
-
groupstring -
The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to
default. -
idstringrequired -
The identifier for the connector saved object.
-
paramsmap string to objectrequired -
The parameters for the action, which are sent to the connector. The
paramsare handled as Mustache templates and passed a default set of context. -
use_alert_data_for_templateboolean -
Indicates whether to use alert data as a template.
-
uuidstring -
A universally unique identifier (UUID) for the action.
-
active_snoozesstring -
alert_delayobject -
Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.
-
activenumberrequired -
The number of consecutive runs that must meet the rule conditions.
-
api_key_created_by_userbooleannullable -
Indicates whether the API key that is associated with the rule was created by the user.
-
api_key_ownerstringrequired nullable -
The owner of the API key that is associated with the rule and used to run background tasks.
-
artifactsobject -
dashboardsobject -
idstringrequired -
investigation_guideobject -
blobstringrequired -
User-created content that describes alert causes and remdiation.
-
consumerstringrequired -
The name of the application or feature that owns the rule. For example:
alerts,apm,discover,infrastructure,logs,metrics,ml,monitoring,securitySolution,siem,stackAlerts, oruptime. -
created_atstringrequired -
The date and time that the rule was created.
-
created_bystringrequired nullable -
The identifier for the user that created the rule.
-
enabledbooleanrequired -
Indicates whether you want to run the rule on an interval basis after it is created.
-
execution_statusobjectrequired -
errorobject -
last_durationnumber -
Duration of last execution of the rule.
-
last_execution_datestringrequired -
The date and time when rule was executed last.
-
flappingobjectnullable -
When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
-
look_back_windownumber · min: 2 · max: 20required -
The minimum number of runs in which the threshold must be met.
-
status_change_thresholdnumber · min: 2 · max: 20required -
The minimum number of times an alert must switch states in the look back window.
-
idstringrequired -
The identifier for the rule.
-
is_snoozed_untilstringnullable -
The date when the rule will no longer be snoozed.
-
last_runobjectnullable -
alerts_countobjectrequired -
outcome -
Outcome of last run of the rule. Value could be succeeded, warning or failed.
-
Values:
succeededwarningfailed -
outcome_msgstringnullable -
outcome_ordernumber -
Order of the outcome.
-
warning -
Warning of last rule execution.
-
Values:
readdecryptexecuteunknownlicensetimeoutdisabledvalidatemaxExecutableActionsmaxAlertsmaxQueuedActionsruleExecution -
mapped_paramsmap string to object -
monitoringobject -
Monitoring details of the rule.
-
runobjectrequired -
Rule run details.
-
calculated_metricsobjectrequired -
Calculation of different percentiles and success ratio.
-
p50number -
p95number -
p99number -
success_rationumberrequired -
historyobjectrequired -
History of the rule run.
-
last_runobjectrequired -
metricsobjectrequired -
durationnumber -
Duration of most recent rule run.
-
gap_duration_snumbernullable -
Duration in seconds of rule run gap.
-
gap_rangeobjectnullable -
total_alerts_creatednumbernullable -
Total number of alerts created during last rule run.
-
total_alerts_detectednumbernullable -
Total number of alerts detected during last rule run.
-
total_indexing_duration_msnumbernullable -
Total time spent indexing documents during last rule run in milliseconds.
-
total_search_duration_msnumbernullable -
Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.
-
timestampstringrequired -
Time of the most recent rule run.
-
mute_allbooleanrequired -
Indicates whether all alerts are muted.
-
muted_alert_idsstringrequired -
namestringrequired -
The name of the rule.
-
next_runstringnullable -
Date and time of the next run of the rule.
-
notify_when -
Indicates how often alerts generate actions. Valid values include:
onActionGroupChange: Actions run when the alert status changes;onActiveAlert: Actions run when the alert becomes active and at each check interval while the rule conditions are met;onThrottleInterval: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: You cannot specifynotify_whenat both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values. -
Values:
onActionGroupChangeonActiveAlertonThrottleInterval -
paramsmap string to objectrequired -
The parameters for the rule.
-
revisionnumberrequired -
The rule revision number.
-
rule_type_idstringrequired -
The rule type identifier.
-
runningbooleannullable -
Indicates whether the rule is running.
-
scheduleobjectrequired -
intervalstringrequired -
The interval is specified in seconds, minutes, hours, or days.
-
scheduled_task_idstring -
Identifier of the scheduled task.
-
snooze_scheduleobject -
durationnumberrequired -
Duration of the rule snooze schedule.
-
idstring -
Identifier of the rule snooze schedule.
-
rRuleobjectrequired -
byhournumbernullable -
byminutenumbernullable -
bymonthnumbernullable -
bymonthdaynumbernullable -
bysecondnumbernullable -
bysetposnumbernullable -
byweekdaynumber | stringnullable -
byweeknonumbernullable -
byyeardaynumbernullable -
countnumber -
Number of times the rule should recur until it stops.
-
dtstartstringrequired -
Rule start date in Coordinated Universal Time (UTC).
-
freq -
Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.
-
Values:
0123456 -
intervalnumber -
Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.
-
tzidstringrequired -
Indicates timezone abbreviation.
-
untilstring -
Recur the rule until this date.
-
skipRecurrencesstring -
throttlestringnullable deprecated -
Deprecated in 8.13.0. Use the
throttleproperty in the actionfrequencyobject instead. The throttle interval, which defines how often an alert generates repeated actions. NOTE: You cannot specify the throttle interval at both the rule and action level. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values. -
updated_atstringrequired -
The date and time that the rule was updated most recently.
-
updated_bystringrequired nullable -
The identifier for the user that updated this rule most recently.
-
view_in_app_relative_urlstringnullable -
Relative URL to view rule in the app.
Indicates an invalid schema or parameters.
Indicates that this call is forbidden.