listIndexes( )

Lists all indexes defined for a data collection.

When an index's status is ACTIVE, it is ready to use. While it is still being created, its status is BUILDING.

When an index's status is DROPPED, it has been dropped successfully. While it is still in the process of being removed, its status is DROPPING.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Managa Data Indexes
Learn more about permission scopes.
Method Declaration
Method Parameters

ID of the data collection for which to list indexes.


Options for retrieving a list of indexes.

Return Type:Promise<ListIndexesResponse>
Was this helpful?