New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
Elastic Docs ›Elasticsearch Guide ›REST APIs ›Synonyms APIs
« Get synonym rule Transform APIs »

Delete synonym ruleedit

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 an individual synonym rule from a synonyms set.

Requestedit

DELETE _synonyms/<synonyms_set>/<synonym_rule>

Prerequisitesedit

Requires the manage_search_synonyms cluster privilege.

Path parametersedit

<synonyms_set>
(Required, string) Synonyms set identifier to update.
<synonym_rule>
(Required, string) Synonym rule identifier to delete.

Response codesedit

404 (Missing resources)
The synonyms_set identifier was not found, or the synonym rule specified by synonym_rule was not found in the synonyms set.

Examplesedit

The following example deletes an existing synonym rule called test-1 for the synonyms set my-synonyms-set:

DELETE _synonyms/my-synonyms-set/test-1
Copy as curlView in Console 
{
  "result": "deleted",
  "reload_analyzers_details": {
    "_shards": {
      "total": 2,
      "successful": 1,
      "failed": 0
    },
    "reload_details": [
      {
        "index": "test-index",
        "reloaded_analyzers": [
          "my_search_analyzer"
        ],
        "reloaded_node_ids": [
          "1wYFZzq8Sxeu_Jvt9mlbkg"
        ]
      }
    ]
  }
}

All analyzers using this synonyms set will be reloaded automatically to reflect the rule being deleted.

« Get synonym rule Transform APIs »