Get a synonym set Generally available; Added in 8.10.0

GET /_synonyms/{id}
Api key auth Basic auth Bearer auth

Required authorization

  • Cluster privileges: manage_search_synonyms

Path parameters

  • id string Required

    The synonyms set identifier to retrieve.

Query parameters

  • from number

    The starting offset for query rules to retrieve.

  • size number

    The max number of query rules to retrieve.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • count number Required

      The total number of synonyms rules that the synonyms set contains.

    • synonyms_set array[object] Required

      Synonym rule details.

      Hide synonyms_set attributes Show synonyms_set attributes object
GET /_synonyms/{id} 
GET _synonyms/my-synonyms-set

resp = client.synonyms.get_synonym(
    id="my-synonyms-set",
)
const response = await client.synonyms.getSynonym({
  id: "my-synonyms-set",
});
response = client.synonyms.get_synonym(
  id: "my-synonyms-set"
)
$resp = $client->synonyms()->getSynonym([
    "id" => "my-synonyms-set",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_synonyms/my-synonyms-set"
Response examples (200)
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"
    }
  ]
}