Clear objects

Clear the records of an index without affecting its settings.

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 can’t clear an index’s analytics data.

Clearing an index counts as one operation but it’s rate-limited:

• If you have more than , your requests will be throttled.
• If you have more than pending requests, further requests will be ignored.

Examples

C#

index.ClearObjects();

// Asynchronous
await index.ClearObjectsAsync();

res, err := index.ClearObjects()

index.clearObjects();

// Asynchronous
index.clearObjectsAsync();

index.clearObjects().then(() => {
  // done
});

index.clearObjects()

$index->clearObjects();

index.clear_objects()

index.clear_objects

client.execute { clear index "INDEX_NAME" }

index.clearObjects { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

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
}