New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
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.12] ›REST APIs ›Security APIs

Get Security index settings

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get Security index settings

edit

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:

GET /_security/settings
Copy as curlTry in Elastic 

The configurable settings can be modified using the Update Security index settings API.

« Get service account credentials API Get token API »
Was this helpful?
Feedback