Get a synonym set

GET /_synonyms/{id}

Auth

Required privileges

Cluster privileges manage_search_synonyms

Path parameters

id string required: The synonyms set identifier to retrieve.

Query parameters

from number · default: 0: The starting offset for synonym rules to retrieve.
size number · default: 10: The max number of synonym rules to retrieve.
search_after string: The synonym rule ID to use as a cursor for pagination. The next page of results will start after this rule ID. This parameter cannot be used with from.

Response

application/json

count number required: The total number of synonyms rules that the synonyms set contains.
synonyms_set object[] required: Synonym rule details.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _synonyms/my-synonyms-set

JavaScript Elasticsearch JavaScript Client

const response = await client.synonyms.getSynonym({
  id: "my-synonyms-set",
});

Python Elasticsearch Python Client

resp = client.synonyms.get_synonym(
    id="my-synonyms-set",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.synonyms().getSynonym(g -> g
    .id("my-synonyms-set")
);

C# Elasticsearch .NET Client

var response = await client.Synonyms.GetSynonymAsync(id: "my-synonyms-set");

PHP Elasticsearch PHP Client

$resp = $client->synonyms()->getSynonym([
    "id" => "my-synonyms-set",
]);

Ruby Elasticsearch Ruby Client

response = client.synonyms.get_synonym(
  id: "my-synonyms-set"
)

Response

A successful response from GET _synonyms/my-synonyms-set.

{
  "count": 3,
  "synonyms_set": [
    {
      "id": "test-1",
      "synonyms": "hello, hi"
    },
    {
      "id": "test-2",
      "synonyms": "bye, goodbye"
    },
    {
      "id": "test-3",
      "synonyms": "test => check"
    }
  ]
}