Type to search.

Get a synonym set

  • GET /_synonyms/{id}
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 8.10 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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 Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.5 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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.

id string required

The identifier for the synonym rule. If you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch.

synonyms string required

The synonyms that conform the synonym rule in Solr format.

Reference