stack es query-rules put-rule cli command
Auth required
Idempotent
Scope: global
elastic stack es query-rules put-rule \
--type <type> \
--criteria <criteria> \
--actions <actions> \
--ruleset-id <ruleset-id> \
--rule-id <rule-id> \
[options]
Create or update a query rule.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--typeenumrequired-
The type of rule.
Values: pinned, exclude
--criteriastringrequired-
The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.
Repeatable: pass
--criteriamultiple times to supply more than one value --actionsstringrequired- The actions to take when the rule is matched. The format of this action depends on the rule type.
--ruleset-idstringrequired- The unique identifier of the query ruleset containing the rule to be created or updated.
--rule-idstringrequired- The unique identifier of the query rule within the specified ruleset to be created or updated.
--prioritynumber--[no-]error-trace- When set to
trueElasticsearch will include the full stack trace of errors when they occur. --filter-pathstring-
Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
Repeatable: pass
--filter-pathmultiple times to supply more than one value --[no-]human- When set to
truewill return statistics in a format suitable for humans. For example"exists_time": "1h"for humans and"exists_time_in_millis": 3600000for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. --[no-]pretty- If set to
truethe returned JSON will be "pretty-formatted". Only use this option for debugging only. --input-filestring- path to a JSON file to use as command input
--[no-]dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--[no-]json-
output as JSON