Delete Synonym
editSettings
ACL
$index->deleteSynonym(string objectID) $index->deleteSynonym(string objectID, [ // All the following parameters are optional forwardToReplicas => boolean ])
About this method
You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
Remove a single synonym from an index using its object id.
Examples
1
2
3
4
5
// Delete and forward to replicas
$index->deleteSynonym("a-unique-identifier", [
'forwardToReplicas' => true
]);
Parameters
objectID
|
type: string
Required
objectID of the synonym to delete |
forwardToReplicas
|
type: boolean
default: false
optional
Will delete synonym on all replicas. Without this parameter, or by setting it to false, the method still applies the change only to the specified index. If you want to forward the delete to your replicas you will need to set this parameter to true. |
requestOptions
|
type: key/value mapping
default: No request options
Optional
A mapping of |
Response
In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.
JSON format
1
2
3
4
{
"deletedAt":"2013-01-18T15:33:13.556Z",
"taskID": 678
}
deletedAt
|
string
Date at which the indexing job has been created. |
taskID
|
integer
The taskID used with the waitTask method. |