Api clients / JavaScript / V3 / Methods

Clear Objects | JavaScript API Client V3 (Deprecated)

Deprecated content
This documentation is for a deprecated version of JavaScript API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of JavaScript API client for up-to-date information.
Required API Key: any key with the deleteIndex ACL
Method signature
index.clearIndex(callback)

About this method

Clear the records of an index without affecting its settings.

This method enables you to delete an index’s contents (records) without removing any settings, rules and synonyms.

If you want to remove the entire index and not just its records, use the delete method instead.

Clearing an index will have no impact on its Analytics data because you cannot clear an index’s analytics data.

Note this is an expensive operation:

  • when you have more than 100 requests pending, your requests will be throttled.
  • when you have more than 5000 requests pending, further requests will be ignored.
  • if needed, these values can be tuned through configuration.

Examples

1
$index->clearObjects();

Parameters

No parameters for this method.

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
{
  "updatedAt": "2017-12-18T21:22:40.761Z",
  "taskID": 19541511530
}
updatedAt
string

Date at which the job to clear the index has been created.

taskID
integer

This is the taskID which is used with the waitTask method.

Did you find this page helpful?