get-settings.asciidoc 869 B

1234567891011121314151617181920212223242526
  1. [role="xpack"]
  2. [[watcher-api-get-settings]]
  3. === Get Watcher index settings
  4. ++++
  5. <titleabbrev>Get Watcher settings</titleabbrev>
  6. ++++
  7. .New API reference
  8. [sidebar]
  9. --
  10. For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
  11. --
  12. 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:
  13. - `index.auto_expand_replicas`
  14. - `index.number_of_replicas`
  15. An example of retrieving the Watcher settings:
  16. [source,console]
  17. -----------------------------------------------------------
  18. GET /_watcher/settings
  19. -----------------------------------------------------------
  20. The configurable settings can be modified using the <<watcher-api-update-settings,Update Watcher index settings>> API.