Delete an index

Required ACL: deleteIndex

Deleting an index doesn’t delete its analytics data.
If you try to delete a non-existing index, the operation is ignored without warning.
If the index you want to delete has replica indices, the replicas become independent indices.
If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see Delete replica indices.

Usage

// Initialize the client
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));

// Call the API
var response = await client.DeleteIndexAsync("<YOUR_INDEX_NAME>");

// print the response
Console.WriteLine(response);

// Initialize the client
final client =
    SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

// Call the API
final response = await client.deleteIndex(
  indexName: "<YOUR_INDEX_NAME>",
);

// print the response
print(response);

// Initialize the client
client, err := search.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

// Call the API
response, err := client.DeleteIndex(client.NewApiDeleteIndexRequest(
  "<YOUR_INDEX_NAME>"))
if err != nil {
  // handle the eventual error
  panic(err)
}


// print the response
print(response)

// Initialize the client
SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

// Call the API
DeletedAtResponse response = client.deleteIndex("<YOUR_INDEX_NAME>");

// print the response
System.out.println(response);

// Initialize the client
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

// Call the API
const response = await client.deleteIndex({ indexName: 'theIndexName' });


// print the response
console.log(response);

// Initialize the client
val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

// Call the API
var response = client.deleteIndex(indexName = "<YOUR_INDEX_NAME>")


// print the response
println(response)

// Initialize the client
$client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

// Call the API
$response = $client->deleteIndex(
    '<YOUR_INDEX_NAME>',
);


// print the response
var_dump($response);

# Initialize the client
# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

# Call the API
response = client.delete_index(
    index_name="<YOUR_INDEX_NAME>",
)


# print the response
print(response)

# Initialize the client
client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

# Call the API
response = client.delete_index("<YOUR_INDEX_NAME>")


# print the response
puts(response)

// Initialize the client
val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

// Call the API
val response = Await.result(
  client.deleteIndex(
    indexName = "<YOUR_INDEX_NAME>"
  ),
  Duration(100, "sec")
)

// print the response
println(response)

// Initialize the client
let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

// Call the API
let response = try await client.deleteIndex(indexName: "<YOUR_INDEX_NAME>")

// print the response
print(response)

See the full API reference

For more details about input parameters and response fields.

See also: Delete indices

API clients (current)

Reference

Delete an index

Usage

See the full API reference

​Usage

See the full API reference

Usage