Run a watch
- POST also PUT /_watcher/watch/{id}/_execute
- POST also PUT /_watcher/watch/_execute
This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.
For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.
You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher.
When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.
If your user is allowed to read index a, but not index b, then the exact same set of rules will apply during execution of a watch.
When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.
Required authorization
- Cluster privileges manage_watcher
Request body
-
action_modesmap string to enum -
Determines how to handle the watch actions as part of the watch execution.
-
<string> -
Values:
simulateforce_simulateexecuteforce_executeskip -
alternative_inputmap string to object -
When present, the watch uses this object as a payload instead of executing its own input.
-
ignore_conditionboolean · default: false -
When set to
true, the watch execution uses the always condition. This can also be specified as an HTTP parameter. -
record_executionboolean · default: false -
When set to
true, the watch record representing the watch execution result is persisted to the.watcher-historyindex for the current time. In addition, the status of the watch is updated, possibly throttling subsequent runs. This can also be specified as an HTTP parameter. -
trigger_dataobject -
This structure is parsed as the data of the trigger event that will be used during the watch execution.
-
watchobject · default: null -
When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and
record_executioncannot be set. -
actionsmap string to objectrequired -
<string>object -
transformobject -
searchobject -
requestobjectrequired -
bodyobject -
queryQueryrequired -
indices_optionsobject -
allow_no_indicesboolean -
If false, the request returns an error if any wildcard expression, index alias, or
_allvalue targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*returns an error if an index starts withfoobut no index starts withbar. -
expand_wildcardsstring -
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as
open,hidden.Supported values include:
all: Match any data stream or index, including hidden ones.open: Match open, non-hidden indices. Also matches any non-hidden data stream.closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.hidden: Match hidden data streams and hidden indices. Must be combined withopen,closed, orboth.none: Wildcard expressions are not accepted.
-
Values:
allopenclosedhiddennone -
If true, missing or closed indices are not included in the response.
-
search_type -
Supported values include:
query_then_fetch: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.dfs_query_then_fetch: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.
-
Values:
query_then_fetchdfs_query_then_fetch