Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node integrates with the Meilisearch API, specifically allowing users to manage and reset index settings within a Meilisearch instance. The "Reset Index Settings" operation under the "Settings" resource resets the configuration of a specified search index back to its default state. This is useful when you want to clear custom settings such as ranking rules, synonyms, stop-words, or other index-specific configurations that may have been modified.

Practical examples include:

  • Restoring an index's settings after testing different configurations.
  • Quickly reverting changes that negatively impacted search relevance.
  • Automating maintenance tasks where indexes need to be reset periodically.

Properties

Name Meaning
UID The unique identifier (name) of the index whose settings you want to reset. This property is required and must be selected from existing indexes available in your Meilisearch instance.

The UID options are dynamically loaded by fetching the list of indexes from the Meilisearch API endpoint /indexes. The dropdown shows index names along with their primary key fields for easier identification.

Output

The output JSON will contain the response from the Meilisearch API after resetting the index settings. Typically, this includes task information indicating the status of the reset operation, such as whether it was accepted and queued for processing.

No binary data is output by this node.

Dependencies

  • Requires connection to a Meilisearch server via its REST API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL of the Meilisearch instance must be provided in the node credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing index UID: Ensure the UID corresponds to an existing index.
    • Authentication errors: Verify that the API key or token is correctly set up and has sufficient permissions.
    • Network connectivity problems: Confirm that the Meilisearch server URL is reachable from the n8n environment.
  • Error messages:

    • 404 Not Found: The specified index does not exist. Double-check the UID.
    • 401 Unauthorized: Authentication failed. Check API credentials.
    • 400 Bad Request: The request payload is malformed or missing required parameters.

Resolving these typically involves verifying the input properties, credentials, and network access.

Links and References

Discussion