Delete index
This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.
Required API Key:
any key with the
deleteIndex
ACL
suspend fun Index.deleteIndex(
requestOptions: RequestOptions? = null
): DeletionIndex
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 # 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.
Examples # A
Read the Algolia CLI documentation for more information.
Delete an index by name#
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()
Delete multiple indices#
The Algolia CLI lets you delete multiple primary indices at the same time.
1
algolia indices delete YOUR_INDEX_NAME_1 YOUR_INDEX_NAME_2 YOUR_INDEX_NAME_3
Parameters # A
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#
1
2
3
4
{
"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 |