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

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

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

You’re currently reading the Ruby API client v2 documentation. Check the 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).

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 clearObjects method. To delete more than one index, refer to the delete multiple indices guide.

Deleting an index doesn’t affect its analytics data.

If you attempt to delete a nonexistent index, the engine ignores the operation but doesn’t send back an error.

Examples

The Algolia CLI lets you perform many tasks on your Algolia resources from your terminal without having to write any code. Read the Algolia CLI documentation for more information.

Delete an index by name

1
$index->delete();

Delete multiple indices

The Algolia CLI lets you delete multiple primary indices at the same time.

1
algolia index delete <INDEX_1> <INDEX_2> <INDEX_3>

Parameters

indexName
type: string
Required

Name of the index to be deleted.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

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?