Get a synonym rule

Get a synonym rule from a synonym set.

Required authorization

Authorization: <value>

Elasticsearch APIs use 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}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _synonyms/my-synonyms-set/test-1

JavaScript Elasticsearch JavaScript Client

const response = await client.synonyms.getSynonymRule({
  set_id: "my-synonyms-set",
  rule_id: "test-1",
});

Python Elasticsearch Python Client

resp = client.synonyms.get_synonym_rule(
    set_id="my-synonyms-set",
    rule_id="test-1",
)

curl Shell

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

Java Elasticsearch Java Client

client.synonyms().getSynonymRule(g -> g
    .ruleId("test-1")
    .setId("my-synonyms-set")
);

C# Elasticsearch .NET Client

var response = await client.Synonyms.GetSynonymRuleAsync(setId: "my-synonyms-set", ruleId: "test-1");

PHP Elasticsearch PHP Client

$resp = $client->synonyms()->getSynonymRule([
    "set_id" => "my-synonyms-set",
    "rule_id" => "test-1",
]);

Ruby Elasticsearch Ruby Client

response = client.synonyms.get_synonym_rule(
  set_id: "my-synonyms-set",
  rule_id: "test-1"
)

Response

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

{
  "id": "test-1",
  "synonyms": "hello, hi"
}