get-settings.asciidoc 738 B

1234567891011121314151617181920
  1. [role="xpack"]
  2. [[watcher-api-get-settings]]
  3. === Get Watcher index settings
  4. ++++
  5. <titleabbrev>Get Watcher settings</titleabbrev>
  6. ++++
  7. 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:
  8. - `index.auto_expand_replicas`
  9. - `index.number_of_replicas`
  10. An example of retrieving the Watcher settings:
  11. [source,console]
  12. -----------------------------------------------------------
  13. GET /_watcher/settings
  14. -----------------------------------------------------------
  15. The configurable settings can be modified using the <<watcher-api-update-settings,Update Watcher index settings>> API.