Reload search analyzers

POST also GET /{index}/_reload_search_analyzers

Reload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.

IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.

You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers.

NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.

Required authorization

Index privileges: manage

Read the reference documentation

Path Parameters

index union IndexName | [] IndexName required: A comma-separated list of index names to reload analyzers for

Query Parameters

Response

application/json

Examples

A successful response when reloading a search analyzer of an index.

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST /my-index-000001/_reload_search_analyzers

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.reloadSearchAnalyzers({
  index: "my-index-000001",
});

Python Elasticsearch Python Client

resp = client.indices.reload_search_analyzers(
    index="my-index-000001",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_reload_search_analyzers" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

C# Elasticsearch .NET Client

var response = await client.Indices.ReloadSearchAnalyzersAsync(indices: new[] { "my-index-000001" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->reloadSearchAnalyzers([
    "index" => "my-index-000001",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.reload_search_analyzers(
  index: "my-index-000001"
)

Response

{
  "template": {
    "settings": {
      "number_of_shards": 1
    },
    "mappings": {
      "_source": {
        "enabled": false
      },
      "properties": {
        "host_name": {
          "type": "keyword"
        },
        "created_at": {
          "type": "date",
          "format": "EEE MMM dd HH:mm:ss Z yyyy"
        }
      }
    }
  }
}

Required authorization

Path Parameters

Query Parameters { allow_no_indices , expand_wildcards , ignore_unavailable , resource , }

Response

Query Parameters