mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
255c9a7f95
**Problem:** For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. **Solution:** - Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory - Update doc snippet tests to use security Rel: https://github.com/elastic/platform-docs-team/issues/208
27 lines
968 B
Text
27 lines
968 B
Text
[role="xpack"]
|
|
[[security-api-get-settings]]
|
|
=== Get Security index settings
|
|
++++
|
|
<titleabbrev>Get Security settings</titleabbrev>
|
|
++++
|
|
|
|
==== {api-prereq-title}
|
|
|
|
* To use this API, you must have at least the `read_security` cluster privilege.
|
|
|
|
==== {api-description-title}
|
|
This API allows a user to retrieve the user-configurable settings for the Security internal index (`.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes:
|
|
|
|
- `index.auto_expand_replicas`
|
|
- `index.number_of_replicas`
|
|
|
|
An example of retrieving the Security settings:
|
|
|
|
[source,console]
|
|
-----------------------------------------------------------
|
|
GET /_security/settings
|
|
-----------------------------------------------------------
|
|
// TEST[setup:user_profiles]
|
|
// TEST[setup:service_token42]
|
|
|
|
The configurable settings can be modified using the <<security-api-update-settings,Update Security index settings>> API.
|