Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node allows you to update an existing API key in a Meilisearch instance. It is useful for managing access control by modifying the name and description of an API key without having to delete and recreate it. Common scenarios include updating the label or purpose of a key as team roles change, or clarifying its usage for audit purposes.

Practical Example:
Suppose your organization uses multiple API keys for different applications. If the application’s purpose changes, you can use this node to update the key’s name and description to reflect its new role, ensuring clarity in your Meilisearch dashboard.

Properties

Name Meaning
UID The unique identifier (UID) or key of the API key you want to update. Required.
Name The new name for the API key. Optional but recommended for clarity.
Description A description for the API key, explaining its intended use. Optional but helpful.

Output

The output will be a JSON object representing the updated API key. Typical fields may include:

{
  "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "My Key",
  "description": "Description of the key",
  // ...other key metadata fields as returned by Meilisearch
}

No binary data is produced by this operation.

Dependencies

  • Meilisearch Instance: You must have access to a running Meilisearch server.
  • API Credentials: The node requires a valid meilisearchApi credential, including the host URL and an admin/master API key with permission to manage keys.
  • n8n Configuration: Ensure that the Meilisearch credentials are set up in n8n under the appropriate credential type.

Troubleshooting

  • Invalid UID: If you provide a UID that does not exist, Meilisearch will return an error indicating the key was not found. Double-check the UID value.
  • Insufficient Permissions: If the API key used for authentication lacks sufficient permissions, you may receive a "Forbidden" or "Unauthorized" error. Use an admin or master key.
  • Connection Issues: Errors such as "ECONNREFUSED" or "ENOTFOUND" indicate network or configuration problems connecting to your Meilisearch instance. Verify the host URL and network connectivity.

Links and References

Discussion