get-settings.asciidoc 748 B

1234567891011121314151617181920212223242526272829
  1. [[cluster-get-settings]]
  2. === Cluster get settings API
  3. ++++
  4. <titleabbrev>Cluster get settings</titleabbrev>
  5. ++++
  6. Returns cluster-wide settings.
  7. `GET /_cluster/settings`
  8. [[cluster-get-settings-api-desc]]
  9. ==== {api-description-title}
  10. By default, this API call only returns settings that have been explicitly
  11. defined, but can also include the default settings by calling the
  12. `include_defaults` parameter.
  13. [[cluster-get-settings-api-query-params]]
  14. ==== {api-query-parms-title}
  15. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
  16. `include_defaults`::
  17. (Optional, boolean) If `true`, returns all default cluster settings.
  18. Defaults to `false`.
  19. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]