Elastic Docs ›Elasticsearch Guide ›REST APIs ›Synonyms APIs
« List synonyms sets Create or update synonym rule »

Delete synonyms setedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Deletes a synonyms set.

Requestedit

DELETE _synonyms/<synonyms_set>

Prerequisitesedit

Path parametersedit

<synonyms_set>
(Required, string) Synonyms set identifier to delete.

Response codesedit

400
The synonyms_set identifier was not provided, or the synonyms set can’t be deleted because it does not meet the specified requirements.
404 (Missing resources)
No synonyms set with the identifier synonyms_set was found.

Examplesedit

The following example deletes a synonyms set called my-synonyms-set:

DELETE _synonyms/my-synonyms-set

Delete synonyms set analyzer requirementsedit

synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers.

Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.

If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.

To prevent that, synonyms sets that are used in analyzers can’t be deleted. A delete request in this case will return a 400 response code with the following error message:

{
  "error": {
    "root_cause": [
      {
        "type": "illegal_argument_exception",
        "reason": "synonyms set [my-synonyms-set] cannot be deleted as it is used in the following indices: index-1, index-2",
        "stack_trace": ...
      }
    ],
    "type": "illegal_argument_exception",
    "reason": "synonyms set [my-synonyms-set] cannot be deleted as it is used in the following indices: index-1, index-2",
    "stack_trace": ...
  },
  "status": 400
}

To remove a synonyms set, you must first remove all indices that contain analyzers using it. You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the Reindex in order to copy over the index data. Once finished, you can delete the index.

When the synonyms set is not used in analyzers, you will be able to delete it.

« List synonyms sets Create or update synonym rule »