API Reference / API Methods / Manage indices / List indices

Aug. 16, 2022

List Indices

Required API Key: any key with the listIndexes ACL

Method signature

$client->listIndices()

client.list_indexes()

client.listIndices()

client.list_indices()

client.listIndices(
  requestOptions: RequestOptions? = nil,
  completion: Result<IndicesListResponse> -> Void
)

suspend fun ClientSearch.listIndices(
    requestOptions: RequestOptions? = null
): ResponseListIndices

client.ListIndices()

client.listIndices()

client.ListIndices()

list.indexes

See code examples

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

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.

Get a list of indices with their associated metadata.

This method retrieves a list of all indices associated with a given Application ID.

The returned list includes the names of the indices as well as their associated metadata, such as the number of records, size, and last build time.

The list of indices follows any ACL restrictions of the API key used to retrieve it. For example, if you call this method with an API key that has access to only some indices, you will only retrieve these.

Examples

Read the Algolia CLI documentation for more information.

To see a complete app, including all import and setup instructions, go to Install the .NET API client.

To see a complete app, including all import and setup instructions, go to Install the Go API client.

To see a complete app, including all import and setup instructions, go to Install the Java API client.

To see a complete app, including all import and setup instructions, go to Install the Kotlin API client.

To see a complete app, including all import and setup instructions, go to Install the Scala API client.

To see a complete app, including all import and setup instructions, go to Install the Swift API client.

Copy

1
2
3
4
5
6
7
8
9
<?php
require_once __DIR__."/vendor/autoload.php";
use Algolia\AlgoliaSearch\SearchClient;

// Use an API key with `listIndexes` ACL
$client = SearchClient::create(
  'YourApplicationID', 'YourAPIKey'
);
$indices = $client->listIndices()['items'];

1
2
3
4
5
6
7
8
require 'algolia'

# Use an API key with `listIndexes` ACL
client = Algolia::Search::Client.create(
  'YourApplicationID', 'YourAPIKey'
)

indices = client.list_indexes[:items]

1
2
3
4
5
6
7
const algoliasearch = require('algoliasearch');

// Use an API key with `listIndexes` ACL
const client = algoliasearch('YourApplicationID', 'YourAPIKey');
client.listIndices().then(({ items }) => {
  console.log(items);
});

1
2
3
4
5
from algoliasearch.search_client import SearchClient

# Use an API key with `listIndexes` ACL
client = SearchClient.create("YourApplicationID", "YourAPIKey")
indices = client.list_indices()["items"]

1
2
3
4
5
6
7
8
9
10
11
12
13
import AlgoliaSearchClient

// Use an API key with `listIndexes` ACL
let client = SearchClient(
  appID: "YourApplicationID",
  apiKey: "YourAPIKey"
)

client.listIndices { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
// Use an API key with `listIndexes` ACL
val client = ClientSearch(
  ApplicationID("YourApplicationID"),
  APIKey("YourAPIKey")
)
val indices = client.listIndices().items

1
2
3
4
5
6
// Use an API key with `listIndexes` ACL
var client = new SearchClient("YourApplicationID", "YourAPIKey");
var indices = client.ListIndices().Items;

// Asynchronous
await client.ListIndicesAsync();

1
2
3
4
5
6
// Use an API key with `listIndexes` ACL
SearchClient client = DefaultSearchClient.create("YourApplicationID", "YourAPIKey");
List<IndicesResponse> indices = client.listIndices();

// Asynchronous
client.listIndicesAsync();

1
2
3
4
// Use an API key with `listIndexes` ACL
client := search.NewClient("YourApplicationID", "YourAPIKey")
response, err := client.ListIndices()
indices = response.Items

1
2
3
4
5
// Use an API key with `listIndexes` ACL
val client = new AlgoliaClient("YourApplicationID", "YourAPIKey")
val indices: Indices = Await.result(
  client.execute(list indices), Duration.Inf
)

Parameters

This method doesn't take any parameters.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

Copy

          {
  "items": [
    {
      "name": "movies",
      "createdAt": "2022-09-19T16:36:44.471Z",
      "updatedAt": "2022-09-19T18:02:30.996Z",
      "entries": 100,
      "dataSize": 48450,
      "fileSize": 112927,
      "lastBuildTimeS": 3,
      "numberOfPendingTasks": 0,
      "pendingTask": false
    }
  ],
  "nbPages": 1
}

        

`items`	list of index object
`nbPages`	integer The value is always 1. There is no pagination for this method. All indices are returned on the first call.

items ➔ index object

`name`	string Index name.
`createdAt`	string Index creation date. An empty string means that the index has no records.
`updatedAt`	string Date of last update. An empty string means that the index has no records.
`entries`	integer Number of objects in the index.
`dataSize`	integer Number of bytes of the index in minified format.
`fileSize`	integer Number of bytes of the index binary file.
`lastBuildTimeS`	integer Last build time in seconds.
`numberOfPendingTasks`	integer Deprecated. Number of pending indexing operations.
`pendingTask`	boolean Deprecated. A boolean which is `true` if the index has pending tasks.
`primary`	string If the index is a replica, this field has the name of the related primary index. This field is absent for primary indices. Note: In the Go API client, `primary` is an empty string for primary indices.
`replicas`	string[] If the index is a primary index, this field has the names of all related replica indices. This field is absent for replica indices.

Did you find this page helpful?