Query watches

POST also GET /_watcher/_query/watches

Auth

Get all registered watches in a paginated manner and optionally filter watches by a query.

Note that only the _id and metadata.* fields are queryable or sortable.

Required privileges

Cluster privileges monitor_watcher

Request body

from number · default: 0: The offset from the first result to fetch. It must be non-negative.
size number · default: 10: The number of hits to return. It must be non-negative.
query {} Query: A query that filters the watches to be returned.
sort union oneOf: One or more fields used to sort the search results.; Reference
search_after union[]: Retrieve the next page of hits using a set of sort values from the previous page.; Reference

Response

application/json

count number required: The total number of watches found.
watches object[] required: A list of watches based on the from, size, or search_after request body parameters.

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST /_watcher/_query/watches

JavaScript Elasticsearch JavaScript Client

const response = await client.watcher.queryWatches();

Python Elasticsearch Python Client

resp = client.watcher.query_watches()

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_watcher/_query/watches" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.watcher().queryWatches();

PHP Elasticsearch PHP Client

$resp = $client->watcher()->queryWatches();

Ruby Elasticsearch Ruby Client

response = client.watcher.query_watches

Response

A successful response from GET /_watcher/_query/watches.

{
  "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
      }
  ]
}