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.

Required API Key: any key with the deleteIndex ACL

Method signature
index.clear_objects()

About this method # A

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 # A

1
index.clear_objects()

Parameters # A

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

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

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": "2017-12-18T21:22:40.761Z",
  "taskID": 19541511530
}
Field Description
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?
Python API clients v3