stack es watcher put-watch cli command
Auth required
Idempotent
Scope: global
elastic stack es watcher put-watch --id <id> [options]
Create or update a watch.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--idstringrequired- The identifier for the watch.
--[no-]active- The initial state of the watch.
The default value is
true, which means the watch is active by default. --if-primary-termnumber- Only update the watch if the last operation that has changed the watch has the specified primary term
--if-seq-nonumber- Only update the watch if the last operation that has changed the watch has the specified sequence number
--versionnumber- Explicit version number for concurrency control
--actionsstring- The list of actions that will be run if the condition matches.
--conditionstring- The condition that defines if the actions should be run.
--inputstring- The input that defines the input that loads the data for the watch.
--metadatastring- Metadata JSON that will be copied into the history entries.
--throttle-periodstring- The minimum time between actions being run.
The default is 5 seconds.
This default can be changed in the config file with the setting
xpack.watcher.throttle.period.default_period. If both this value and thethrottle_period_in_millisparameter are specified, Watcher uses the last parameter included in the request. --throttle-period-in-millisstring- Minimum time in milliseconds between actions being run. Defaults to 5000. If both this value and the throttle_period parameter are specified, Watcher uses the last parameter included in the request.
--transformstring- The transform that processes the watch payload to prepare it for the watch actions.
--triggerstring- The trigger that defines when the watch should run.
--[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