New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create or update synonym rule Delete synonym rule »
Elastic Docs ›Elasticsearch Guide [8.10] ›REST APIs ›Synonyms APIs

Get synonym rule

edit

Get synonym rule

edit

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.

Retrieves a synonym rule from a synonyms set.

Request

edit

GET _synonyms/<synonyms_set>/<synonym_rule>

Prerequisites

edit

Requires the manage_search_synonyms cluster privilege.

Path parameters

edit
<synonyms_set>
(Required, string) Synonyms set identifier to retrieve the synonym rule from.
<synonym_rule>
(Required, string) Synonym rule identifier to retrieve.

Response codes

edit
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.

Examples

edit

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

GET _synonyms/my-synonyms-set/test-1
Copy as curlTry in Elastic 
{
  "id": "test-1",
  "synonyms": "hello, hi"
}
« Create or update synonym rule Delete synonym rule »

On this page

Was this helpful?
Feedback