get-settings.asciidoc 676 B

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