View API Reference

Manage Indices


API Method Description PHP Ruby JS Python iOS Android C# Java Go Scala name
List indexes

Get a list of all indexes with their associated settings.

listIndexes list_indexes listIndexes list_indexes listIndexes listIndexesAsync listIndexes listIndices ListIndexes list.indices()
Delete index

Delete an index and all of its settings.

deleteIndex delete_index deleteIndex delete_index deleteIndex deleteIndexAsync deleteIndex delete Delete delete index
Copy index

Make a copy of an index, including its settings, synonyms, and query rules.

copyIndex copy_index copyIndex copy_index copyIndex copyIndexAsync CopyIndex copyIndex CopyIndex copy index
Move index

Move or rename an index. Normally used to reindex your data without any down time.

moveIndex move_index moveIndex move_index moveIndex moveIndexAsync MoveIndex moveTo MoveIndex move index
Clear index

Clear the contents of an index without affecting its settings.

clearIndex clear_index clearIndex clear_index clearIndex clearIndexAsync ClearIndex clear Clear clear index

Create an index

You don’t need to explicitly create an index, it will be automatically created the first time you add an object or set settings.