List indices

Lists all indices in the current Algolia application.

GET /1/indexes

curl

cURL

curl --request GET \
  --url 'https://algolia_application_id.algolia.net/1/indexes?page=0&hitsPerPage=100' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "items": [
    {
      "name": "movies",
      "createdAt": "2022-09-19T16:36:44.471Z",
      "updatedAt": "2023-07-04T12:49:15Z",
      "entries": 100,
      "dataSize": 48450,
      "fileSize": 112927,
      "lastBuildTimeS": 3,
      "numberOfPendingTasks": 0,
      "pendingTask": false,
      "primary": "T02",
      "replicas": [
        "T02_push",
        "T2replica"
      ],
      "virtual": true
    }
  ],
  "nbPages": 100
}

The request follows any index restrictions of the API key you use to make the request.

Required ACL: listIndexes

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

page · integer | null

Requested page of the API response. If null, the API response is not paginated.

Required range: x >= 0

hitsPerPage · integer · default: 100

Number of hits per page.

Response

200

application/json

OK

items · object[] · required

All indices in your Algolia application.

Show child attributes

nbPages · integer

Number of pages.

Example:

100