Skip to main content
This page documents an earlier version of the API client. For the latest version, see Delete all records from an index.
Required ACL: deleteIndex 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 has no impact on its Analytics data because you cannot clear an index’s analytics data. Clearing an index counts as one operation but it’s rate-limited:
  • If you have more than 100 pending requests, your requests will be throttled.
  • If you have more than 5,000 pending requests, further requests will be ignored.

​
Examples

index.ClearObjects();

// Asynchronous
await index.ClearObjectsAsync();

​
Parameters

​
requestOptions
object
A mapping of request options to send along with the request.

​
Response

​
taskID
integer
This is the taskID which is used with the waitTask method.
​
updatedAt
string
Date at which the job to clear the index has been created.

​
Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON
{
  "updatedAt": "2017-12-18T21:22:40.761Z",
  "taskID": 19541511530
}
⌘I