Actions33
- Documents Actions
- General Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Indexes → List Indexes
AI-generatedOverview
This node operation lists indexes from a Meilisearch instance. It is useful for retrieving a collection of indexes with optional pagination controls such as offset and limit. This can help users manage and view their search indexes efficiently.
Use Case Examples
- A user wants to fetch all indexes available in their Meilisearch server to display them in a dashboard.
- A user needs to paginate through indexes, skipping the first 10 and limiting the results to 20 indexes per request.
Properties
| Name | Meaning |
|---|---|
| Offset | Number of indexes to skip, used for pagination. |
| Limit | Maximum number of index results to return, used to control the size of the response. |
Output
JSON
json- Array of index objects returned from Meilisearch API, each representing an index with its details.
Dependencies
- Requires Meilisearch API credentials for authentication and access to the Meilisearch server.
Troubleshooting
- Common issues include authentication failures due to incorrect or missing API credentials.
- Errors may occur if the Meilisearch server URL is incorrect or unreachable.
- Pagination parameters (offset and limit) must be valid numbers; otherwise, the request may fail or return unexpected results.
Links
- Meilisearch API - Get All Indexes - Official documentation for the Meilisearch API endpoint to list all indexes.