Get searchable snapshot statistics

GET /{index}/_searchable_snapshots/stats
GET /_searchable_snapshots/stats

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

Path parameters

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /my-index/_searchable_snapshots/stats

JavaScript Elasticsearch JavaScript Client

const response = await client.searchableSnapshots.stats({
  index: "my-index",
});

Python Elasticsearch Python Client

resp = client.searchable_snapshots.stats(
    index="my-index",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/my-index/_searchable_snapshots/stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.searchableSnapshots().stats(s -> s
    .index("my-index")
);

C# Elasticsearch .NET Client

var response = await client.SearchableSnapshots
    .StatsAsync(d1 => d1
        .Indices(new[] { "my-index" })
    );

PHP Elasticsearch PHP Client

$resp = $client->searchableSnapshots()->stats([
    "index" => "my-index",
]);

Ruby Elasticsearch Ruby Client

response = client.searchable_snapshots.stats(
  index: "my-index"
)

Response

No example