mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
43 lines
1.1 KiB
Text
43 lines
1.1 KiB
Text
[[cluster-get-settings]]
|
|
=== Cluster get settings API
|
|
++++
|
|
<titleabbrev>Cluster get settings</titleabbrev>
|
|
++++
|
|
|
|
Returns cluster-wide settings.
|
|
|
|
[source,console]
|
|
----
|
|
GET /_cluster/settings
|
|
----
|
|
|
|
[[cluster-get-settings-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `monitor` or
|
|
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[cluster-get-settings-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_cluster/settings`
|
|
|
|
[[cluster-get-settings-api-desc]]
|
|
==== {api-description-title}
|
|
|
|
By default, this API call only returns settings that have been explicitly
|
|
defined, but can also include the default settings by calling the
|
|
`include_defaults` parameter.
|
|
|
|
|
|
[[cluster-get-settings-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
|
|
|
`include_defaults`::
|
|
(Optional, Boolean) If `true`, returns default cluster settings from the local node.
|
|
Defaults to `false`.
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|