Get all synonym sets Generally available; Added in 8.10.0

View as markdown
GET /_synonyms
Api key auth Basic auth Bearer auth

Get a summary of all defined synonym sets.

Required authorization

  • Cluster privileges: manage_search_synonyms

Query parameters

  • from number

    The starting offset for synonyms sets to retrieve.

  • size number

    The maximum number of synonyms sets to retrieve.

Responses

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

      The total number of synonyms sets defined.

    • results array[object] Required

      The identifier and total number of defined synonym rules for each synonyms set.

      Hide results attributes Show results attributes object
      • synonyms_set string Required

        Synonyms set identifier

      • count number Required

        Number of synonym rules that the synonym set contains
GET /_synonyms 
GET _synonyms 
resp = client.synonyms.get_synonyms_sets()
const response = await client.synonyms.getSynonymsSets();
response = client.synonyms.get_synonyms_sets
$resp = $client->synonyms()->getSynonymsSets();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_synonyms"
Response examples (200)
A successful response from `GET _synonyms`. 
{ "count": 3, "results": [ { "synonyms_set": "ecommerce-synonyms", "count": 2 }, { "synonyms_set": "my-synonyms-set", "count": 3 }, { "synonyms_set": "new-ecommerce-synonyms", "count": 1 } ] }