API client / Methods / Manage indices

Jun. 08, 2023

Delete index

Required API Key: any key with the deleteIndex ACL

Method signature

$index->delete()

index.delete()

index.delete()

index.delete()

index.delete(
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<IndexDeletion>> -> Void
)

suspend fun Index.deleteIndex(
    requestOptions: RequestOptions? = null
): DeletionIndex

index.Delete()

index.delete()

index.Delete()

delete.index(String indexName)

See code examples

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.

About this method

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

Deleting an index doesn’t affect its analytics data.

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

Deleting indices with replicas

When deleting an index with replicas, the replicas become independent indices.

You can’t delete a replica index directly. First, you must unlink it to turn it into a regular index. Then you can delete it.

Deleting only records

To only remove records from the index, use the clearObjects method. This preserves the index’s settings, Rules, and Synonyms.

Deleting multiple indices

To delete more than one index, see Delete multiple indices.

Guide Delete indices

Examples

Read the Algolia CLI documentation for more information.

To see a complete app, including all import and setup instructions, go to Install the .NET API client.

To see a complete app, including all import and setup instructions, go to Install the Go API client.

To see a complete app, including all import and setup instructions, go to Install the Java API client.

To see a complete app, including all import and setup instructions, go to Install the Kotlin API client.

To see a complete app, including all import and setup instructions, go to Install the Scala API client.

To see a complete app, including all import and setup instructions, go to Install the Swift API client.

Delete an index by name

Copy

1
2
3
4
5
6
7
8
9
10
<?php
require_once __DIR__."/vendor/autoload.php";
use Algolia\AlgoliaSearch\SearchClient;

// Use an API key with `deleteIndex` ACL
$client = SearchClient::create(
  'YourApplicationID', 'YourAPIKey'
);
$index = $client->initIndex('YourIndexName');
$index->delete();

1
2
3
4
5
6
7
8
require 'algolia'

# Use an API key with `deleteIndex` ACL
client = Algolia::Search::Client.create(
  'YourApplicationID', 'YourAPIKey'
)
index = client.init_index('YourIndexName')
index.delete

1
2
3
4
5
6
7
const algoliasearch = require('algoliasearch');

// Use an API key with `deleteIndex` ACL
const client = algoliasearch('YourApplicationID', 'YourAPIKey');
const index = client.initIndex('YourIndexName');

index.delete();

1
2
3
4
5
6
from algoliasearch.search_client import SearchClient

# Use an API key with `deleteIndex` ACL
client = SearchClient.create("YourApplicationID", "YourAPIKey")
index = client.init_index("YourIndexName")
index.delete()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import AlgoliaSearchClient

// Use an API key with `deleteIndex` ACL
let client = SearchClient(
  appID: "YourApplicationID",
  apiKey: "YourAPIKey"
)
let index = client.index(withName: "YourIndexName")

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

1
2
3
4
5
6
7
8
// Use an API key with `deleteIndex` ACL
val client = ClientSearch(
  ApplicationID("YourApplicationID"),
  APIKey("YourAPIKey")
)
val index = client.initIndex(IndexName("YourIndexName"))

index.deleteIndex()

1
2
3
4
5
6
7
8
// Use an API key with `deleteIndex` ACL
var client = new SearchClient("YourApplicationID", "YourAPIKey");
var index = client.InitIndex("YourIndexName");

index.Delete();

// Asynchronous
await index.DeleteAsync();

1
2
3
4
5
6
7
8
// Use an API key with `deleteIndex` ACL
SearchClient client = DefaultSearchClient.create("YourApplicationID", "YourAPIKey");
SearchIndex<Record> index = client.initIndex("YourIndexName", Record.class);

index.delete();

//Asynchronous
index.deleteAsync();

1
2
3
4
// Use an API key with `deleteIndex` ACL
client := search.NewClient("YourApplicationID", "YourAPIKey")
index := client.InitIndex("YourIndexName")
res, err := index.Delete()

Delete multiple indices

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

Copy

1
algolia indices delete YOUR_INDEX_NAME_1 YOUR_INDEX_NAME_2 YOUR_INDEX_NAME_3

Parameters

Parameter	Description
`indexName`	type: string Required Name of the index to be deleted.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

          {
  "deletedAt": "2017-12-18T21:22:40.761Z",
  "taskID": 19541511530
}

        

Field	Description
`deletedAt`	string Date at which the job to delete the index has been created.
`taskID`	integer The `taskID` for the `waitTask` method.

Did you find this page helpful?