Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node integrates with the Meilisearch API, specifically allowing users to manage API keys among other resources. The "Get An API Key" operation under the "Keys" resource retrieves details of a specific API key by its unique identifier (UID). This is useful for scenarios where you need to verify or inspect the permissions and metadata associated with an existing API key in your Meilisearch instance.

Practical examples include:

  • Auditing API keys to check their access scopes.
  • Fetching key details before updating or deleting them.
  • Integrating key management into automated workflows for security compliance.

Properties

Name Meaning
UID The unique identifier or key string of the API key to retrieve. This is required to specify which API key's details should be fetched.

Output

The output JSON will contain the details of the requested API key. This typically includes fields such as the key's UID, description, creation date, expiration date (if any), and the permissions/scopes assigned to it. The exact structure depends on the Meilisearch API response but generally provides comprehensive information about the API key.

No binary data output is expected from this operation.

Dependencies

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

Troubleshooting

  • Invalid UID or Key Not Found: If the specified UID does not exist, the node will likely return an error indicating the key was not found. Verify the UID is correct.
  • Authentication Errors: Ensure that the API authentication token is valid and has sufficient permissions to read API keys.
  • Network Issues: Confirm that the Meilisearch host URL is reachable from the n8n environment.
  • Malformed UID Input: The UID should be a properly formatted string; invalid formats may cause request failures.

Links and References

Discussion