get-settings.asciidoc 862 B

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