Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

The node integrates with the Meilisearch API, specifically providing functionality to swap pairs of indexes. This operation is useful when you want to interchange two existing search indexes within Meilisearch, for example, to promote a new version of an index or reorganize your search data without downtime.

Common scenarios include:

  • Swapping a staging index with a production index after reindexing.
  • Quickly switching between different versions of search data.
  • Managing multiple indexes by interchanging their roles dynamically.

Properties

Name Meaning
Index Pairs A collection of pairs of indexes to swap. Each pair requires:
  Index 1 UID The unique identifier string of the first index in the pair.
  Index 2 UID The unique identifier string of the second index in the pair.

You can add multiple index pairs to swap in one execution.

Output

The output JSON will typically contain the response from the Meilisearch API regarding the swap operation status. This may include task identifiers or confirmation that the swap was successful. The exact structure depends on the Meilisearch API response but generally includes metadata about the swap tasks initiated.

No binary data output is expected from this operation.

Dependencies

  • Requires connection to a Meilisearch instance via its API.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The node expects the base URL of the Meilisearch server to be provided in credentials.

Troubleshooting

  • Invalid Index UIDs: If the provided index UIDs do not exist, the API will return an error. Verify that the UIDs are correct and correspond to existing indexes.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to perform index swaps.
  • Network Issues: Confirm that the Meilisearch host URL is reachable from the n8n environment.
  • API Limits or Restrictions: Check if there are any rate limits or restrictions on swapping indexes in your Meilisearch setup.

Links and References

Discussion