honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/cluster/get-settings.asciidoc

20 lines
633 B
Plaintext
Raw Normal View History

rest-high-level: added get cluster settings (#31706) Relates to #27205
2018-07-02 13:25:17 -04:00
[[cluster-get-settings]]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
=== Cluster Get Settings
rest-high-level: added get cluster settings (#31706) Relates to #27205
2018-07-02 13:25:17 -04:00
The cluster get settings API allows to retrieve the cluster wide settings.
[source,js]
--------------------------------------------------
GET /_cluster/settings
--------------------------------------------------
// CONSOLE
Or
[source,js]
--------------------------------------------------
GET /_cluster/settings?include_defaults=true
--------------------------------------------------
// CONSOLE
In the second example above, the parameter `include_defaults` ensures that the settings which were not set explicitly
are also returned. By default `include_defaults` is set to false.