Get Watcher index settings

GET /_watcher/settings

Auth

Get settings for the Watcher internal index (.watches). Only a subset of settings are shown, for example index.auto_expand_replicas and index.number_of_replicas.

Required privileges

Cluster privileges manage_watcher

Query parameters

master_timeout union oneOf · default: 30s: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Response

application/json

index object required

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_watcher/settings

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.watcher.get_settings()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_watcher/settings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.watcher().getSettings(g -> g);

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

response = client.watcher.get_settings

Response

A successful response with two index settings.

{
  "index": {
    "auto_expand_replicas": "0-4",
    "number_of_replicas": 0
  }
}