This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

Required API Key: any key with the editSettings ACL

Method signature
index.ClearSynonyms(
  forwardToReplicas: bool
)

About this method # A

Remove all synonyms from an index.

This is a convenience method to delete all synonyms at once.

This Clear All method should not be used on a production index to push a new list of synonyms because it will result in a short down period during which the index would have no synonyms at all. Instead, use the saveSynonyms (with replaceExistingSynonyms set to true) to atomically replace all synonyms of an index with no down time.

Examples # A

Clear all synonyms and forward to replicas#

1
2
3
4
index.ClearSynonyms(forwardToReplicas: true);

// Asynchronous
await index.ClearSynonymsAsync(forwardToReplicas: true);

Parameters # A

forwardToReplicas #
type: boolean
default: false
optional

Will delete synonyms on all replicas. Without this parameter, or by setting it to false, the method sill apply the change only to the specified index. If you want to forward your deletes to your replicas you will need to set this parameter to true.

Response # A

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format#

1
2
3
4
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
Field Description
updatedAt #
string

Date at which the indexing job has been created.

taskID #
integer

The taskID used with the waitTask method.

Did you find this page helpful?
C# API clients v6