API Reference / API Methods / Manage indices / Delete index
Required API Key: any key with the deleteIndex ACL
Method signature
$index->delete()

About this method

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

You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

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

This method permanently removes an index from your application, and removes its metadata and configured settings (like searchable attributes and custom ranking).

Rather than use the API, you can delete indices using the dashboard.

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 the index is a replica, you must first unlink it before you can delete it.

If you want to only remove records from the index, use the clear method. To delete more than one index, refer to the delete multiple indices guide.

Deleting an index won’t affect analytics data because you can’t delete an index’s analytics data.

If you select and attempt to delete a nonexistent index, the engine ignores the operation but doesn’t 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?