Get all synonym sets

GET /_synonyms

Get a summary of all defined synonym sets.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _synonyms

JavaScript Elasticsearch JavaScript Client

const response = await client.synonyms.getSynonymsSets();

Python Elasticsearch Python Client

resp = client.synonyms.get_synonyms_sets()

curl Shell

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

Java Elasticsearch Java Client

client.synonyms().getSynonymsSets(g -> g);

C# Elasticsearch .NET Client

var response = await client.Synonyms.GetSynonymsSetsAsync();

PHP Elasticsearch PHP Client

$resp = $client->synonyms()->getSynonymsSets();

Ruby Elasticsearch Ruby Client

response = client.synonyms.get_synonyms_sets

Response

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
    }
  ]
}