New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update Watcher index settings Start watch service API »
Elastic Docs ›Elasticsearch Guide [8.13] ›REST APIs ›Watcher APIs

Get Watcher index settings

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get Watcher index settings

edit

This API allows a user to retrieve the user-configurable settings for the Watcher internal index (.watches). Only a subset of the index settings—those that are user-configurable—will be shown. This includes:

  • index.auto_expand_replicas
  • index.number_of_replicas

An example of retrieving the Watcher settings:

response = client.watcher.get_settings
puts response
GET /_watcher/settings
Copy as curlTry in Elastic 

The configurable settings can be modified using the Update Watcher index settings API.

« Update Watcher index settings Start watch service API »
Was this helpful?
Feedback