Get Watcher index settings

GET /_watcher/settings

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.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

Response

application/json

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
  }
}