IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get service account credentials API Get token API »
Elastic Docs ›Elasticsearch Guide [8.18] ›REST APIs ›Security APIs

Get Security index settings

edit
A newer version is available. Check out the latest documentation.

Get Security index settings

edit

New API reference

For the most up-to-date API details, refer to Security APIs.

Retrieves settings for the security internal indices.

Prerequisites

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

Description

edit

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

edit

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.

« Get service account credentials API Get token API »