Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

The node integrates with the Meilisearch API, specifically allowing users to manage and retrieve API keys under the "Keys" resource. The "Get API Keys" operation fetches a list of API keys configured in the Meilisearch instance. This is useful for administrators who want to audit or manage access credentials programmatically.

Common scenarios include:

  • Retrieving all API keys to display or log them.
  • Implementing automated monitoring or auditing of API key usage.
  • Integrating key management into broader workflows that require dynamic access control.

Example: An automation workflow could periodically fetch all API keys to verify their permissions or detect unused keys.

Properties

Name Meaning
Additional Fields Optional parameters to customize the request. Includes:
- Limit Maximum number of API keys to return (minimum 1, default 50).
- Offset Number of API keys to skip before starting to collect the result set (minimum 1, default 1).

Output

The node outputs JSON data representing the list of API keys retrieved from Meilisearch. Each item in the output typically contains details about an individual API key such as its identifier, description, and associated permissions.

If binary data were involved (not applicable here), it would be summarized accordingly, but this operation deals solely with JSON data.

Dependencies

  • Requires connection to a Meilisearch instance via an API endpoint URL.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the Meilisearch API must be provided in the node's credentials configuration.

Troubleshooting

  • Common issues:

    • Incorrect or missing API authentication token will cause authorization failures.
    • Invalid base URL or network connectivity problems will prevent the node from reaching the Meilisearch server.
    • Providing invalid values for Limit or Offset (e.g., less than 1) may cause errors or unexpected results.
  • Error messages:

    • Authorization errors typically indicate invalid or expired API tokens; ensure the correct token is configured.
    • Network errors suggest checking the Meilisearch host URL and network accessibility.
    • Validation errors on input fields can be resolved by adhering to the minimum value constraints.

Links and References

Discussion