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.

About this method # A

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 # A

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(
  'AJ0P3S7DWQ', '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(
  'AJ0P3S7DWQ', '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('AJ0P3S7DWQ', '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("AJ0P3S7DWQ", "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: "AJ0P3S7DWQ",
  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("AJ0P3S7DWQ"),
  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("AJ0P3S7DWQ", "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("AJ0P3S7DWQ", "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("AJ0P3S7DWQ", "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 # A

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

Response # A

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?

Delete index

About this method # Found an issue? Edit this page A Edit this page