API Reference / API Methods / Manage indices / Delete index
Feb. 26, 2019

Delete index

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

About this method

Delete an index and all its settings, including links to its replicas.

This method not only removes an index from your application, it also removes its metadata and configured settings (like searchable attributes or custom ranking).

If the index has replicas, they will be preserved but will no longer be linked to their primary index. Instead, they’ll become independent indices.

If you want to only remove the records from the index, use the clear method.

Deleting an index will have no impact on Analytics data because you cannot delete an index’s Analytics data.

When deleting an inexistent index, the engine ignores the operation but does not send back an error.

Examples

Delete an index by name

1
$index->delete();

Parameters

indexName
type: string
Required

Name of the index to be deleted.

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

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

taskID
integer

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

Did you find this page helpful?