› › ›

Get Security index settings

Retrieves settings for the security internal indices.

Prerequisites

To use this API, you must have at least the read_security cluster privilege.

Description

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

Examples

An 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.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-settings.html