Get cluster-wide settings

GET /_cluster/settings

By default, it returns only settings that have been explicitly defined.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_cluster/settings?filter_path=persistent.cluster.remote

JavaScript Elasticsearch JavaScript Client

const response = await client.cluster.getSettings({
  filter_path: "persistent.cluster.remote",
});

Python Elasticsearch Python Client

resp = client.cluster.get_settings(
    filter_path="persistent.cluster.remote",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cluster/settings?filter_path=persistent.cluster.remote" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

C# Elasticsearch .NET Client

var response = await client.Cluster.GetSettingsAsync();

PHP Elasticsearch PHP Client

$resp = $client->cluster()->getSettings([
    "filter_path" => "persistent.cluster.remote",
]);

Ruby Elasticsearch Ruby Client

response = client.cluster.get_settings(
  filter_path: "persistent.cluster.remote"
)

Response

No example