Algolia DevCon
Oct. 2–3 2024, virtual.

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

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.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

Required API Key: any key with the editSettings ACL

Method signature
$index->clearSynonyms([
  'forwardToReplicas' => boolean
])

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

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

Read the Algolia CLI documentation for more information.

Clear all synonyms and forward to replicas

1
2
3
$index->clearSynonyms([
  'forwardToReplicas' => true
]);

Parameters

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

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?