Type to search.

stack kb alerting get-alerting-rules-find cli command

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview 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.

Auth required Idempotent Scope: global
Shell
elastic stack kb alerting get-alerting-rules-find [options]

Get information about rules

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--per-page number
The number of rules to return per page.
--page number
The page number to return.
An Elasticsearch simple_query_string query that filters the objects in the response.
--default-search-operator enum

The default operator to use for the simple_query_string.

Values: OR, AND

--search-fields string[]

The fields to perform the simple_query_string parsed query against.

Repeatable: pass --search-fields multiple times to supply more than one value

--sort-field string
Determines which field is used to sort the results. The field must exist in the attributes key of the response.
--sort-order enum

Determines the sort order.

Values: asc, desc

--has-reference string
Filters the rules that have a relation with the reference objects with a specific type and identifier.
--fields string[]

The fields to return in the attributes key of the response.

Repeatable: pass --fields multiple times to supply more than one value

--filter string
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 as updatedAt, you must define your filter, for example, savedObjectType.updatedAt > 2018-12-22.
--filter-consumers string[]

Filters the returned rules by the consumer (Kibana application) that owns them, for example: siem, apm, infrastructure.

Repeatable: pass --filter-consumers multiple times to supply more than one value

--input-file string
path to a JSON file to use as command input
--dry-run
validate all inputs and exit without performing any action (preview changes without applying them)
--no-validate
skip input validation and send the request as-is
--output-fields string
comma-separated list of fields to include in output (dot-notation supported)
--output-template string
Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--json

output as JSON