Skip to content

Indexes

GET /indexes

Returns all configured index handles and their engine types. Use the handle value in other API paths (e.g. /:handle/search).

{
"indexes": [
{ "handle": "collections", "engine": "elasticsearch" },
{ "handle": "catalogue", "engine": "opensearch" },
{ "handle": "products", "engine": "meilisearch" }
]
}
FieldTypeDescription
indexesarrayArray of configured indexes.
indexes[].handlestringURL-safe handle used in API paths.
indexes[].enginestringSearch engine type (elasticsearch, opensearch, or meilisearch).
Terminal window
curl http://localhost:3000/indexes