IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Query watches API
editQuery watches API
editRetrieves all registered watches.
Request
editGET /_watcher/_query/watches
Prerequisites
edit-
You must have
manage_watcher
ormonitor_watcher
cluster privileges to use this API. For more information, see Security privileges.
Retrieves all watches in a paginated manner and optionally filtering watches by a query.
This API supports the following fields:
Name | Required | Default | Description |
---|---|---|---|
|
no |
0 |
The offset from the first result to fetch. Needs to be non-negative. |
|
no |
10 |
The number of hits to return. Needs to be non-negative. |
|
no |
null |
Optional, query filter watches to be returned. |
|
no |
null |
Optional sort definition. |
|
no |
null |
Optional search After to do pagination using last hit’s sort values. |
Note that only the _id
and metadata.*
fields are queryable or sortable.
This api returns the following top level fields:
-
count
- The total number of watches found.
-
watches
-
A list of watches based on the
from
,size
orsearch_after
request body parameters.
Examples
editThe following example list all stored watches:
resp = client.watcher.query_watches() print(resp)
const response = await client.watcher.queryWatches(); console.log(response);
GET /_watcher/_query/watches
Response:
{ "count": 1, "watches": [ { "_id": "my_watch", "watch": { "trigger": { "schedule": { "hourly": { "minute": [ 0, 5 ] } } }, "input": { "simple": { "payload": { "send": "yes" } } }, "condition": { "always": {} }, "actions": { "test_index": { "index": { "index": "test" } } } }, "status": { "state": { "active": true, "timestamp": "2015-05-26T18:21:08.630Z" }, "actions": { "test_index": { "ack": { "timestamp": "2015-05-26T18:21:08.630Z", "state": "awaits_successful_execution" } } }, "version": -1 }, "_seq_no": 0, "_primary_term": 1 } ] }