This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Get Security index settings
editGet Security index settings
editRetrieves settings for the security internal indices.
Prerequisites
edit-
To use this API, you must have at least the
read_securitycluster privilege.
Description
editThis 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
Examples
editAn example of retrieving the security settings:
resp = client.security.get_settings() print(resp)
const response = await client.transport.request({
method: "GET",
path: "/_security/settings",
});
console.log(response);
GET /_security/settings
The configurable settings can be modified using the Update Security index settings API.