Get Security index settings

edit

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:

resp = client.perform_request(
    "GET",
    "/_security/settings",
)
print(resp)

const response = await client.security.getSettings();
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 »