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
50 lines
1.8 KiB
Text
50 lines
1.8 KiB
Text
[role="xpack"]
|
|
[[security-api-update-settings]]
|
|
=== Update Security index settings
|
|
++++
|
|
<titleabbrev>Update Security settings</titleabbrev>
|
|
++++
|
|
|
|
==== {api-prereq-title}
|
|
|
|
* To use this API, you must have at least the `manage_security` cluster privilege.
|
|
|
|
==== {api-description-title}
|
|
This API allows a user to modify the settings for the Security internal indices (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes:
|
|
|
|
- `index.auto_expand_replicas`
|
|
- `index.number_of_replicas`
|
|
|
|
An example of modifying the Security settings:
|
|
|
|
[source,console]
|
|
-----------------------------------------------------------
|
|
PUT /_security/settings
|
|
{
|
|
"security": {
|
|
"index.auto_expand_replicas": "0-all"
|
|
},
|
|
"security-tokens": {
|
|
"index.auto_expand_replicas": "0-all"
|
|
},
|
|
"security-profile": {
|
|
"index.auto_expand_replicas": "0-all"
|
|
}
|
|
}
|
|
-----------------------------------------------------------
|
|
// TEST[skip:making sure all the indices have been created reliably is difficult]
|
|
|
|
The configured settings can be retrieved using the <<security-api-get-settings,Get Security index settings>> API. If a
|
|
given index is not in use on the system, but settings are provided for it, the request will be rejected - this API does
|
|
not yet support configuring the settings for these indices before they are in use.
|
|
|
|
==== {api-request-body-title}
|
|
`security`::
|
|
(Optional, object) Settings to be used for the index used for most security configuration, including Native realm users
|
|
and roles configured via the API.
|
|
|
|
`security-tokens`::
|
|
(Optional, object) Settings to be used for the index used to store <<tokens,security-api-get-token>>.
|
|
|
|
`security`::
|
|
(Optional, object) Settings to be used for the index used to store <<Profile,security-api-activate-user-profile>> information.
|