API Reference / API Methods / Indexing / Clear objects

Clear Objects

Required API Key: any key with the deleteIndex ACL
Method signature
$index->clearObjects()

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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.

Clearing an index counts as one operation. Note, however, that this operation is expensive:

  • 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

requestOptions
type: key/value mapping
default: No request options
Optional

A mapping of request options to send along with the request.

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?