List indices
This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.
This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.
This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.
This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.
This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.
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.
This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.
This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.
This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.
This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.
Required API Key:
any key with the
listIndexes
ACL
$client->listIndices()
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
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 can only access some indices, you will only retrieve records from those.
Examples
Read the Algolia CLI documentation for more information.
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'];
Parameters
This method doesn't take any parameters.
Response
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
5
6
7
8
9
10
11
12
13
14
15
16
{
"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
}
Field | Description |
---|---|
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
Field | Description |
---|---|
name
|
string
Index name. |
createdAt
|
string
Index creation date. An empty string means that the index has no records. |
updatedAt
|
string
Date of the last update. An empty string means that the index has no records. |
entries
|
integer
The number of records 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. TRhe number of pending indexing operations. |
pendingTask
|
boolean
Deprecated.
A boolean which is |
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, |
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. |