Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions24

Overview

This node interacts with the Meilisearch API to retrieve a list of API keys. It is useful for administrators or automation workflows that need to audit, manage, or display available API keys within a Meilisearch instance. Common scenarios include listing all API keys for review, integrating key management into dashboards, or automating security checks.

Practical Example:

  • Automatically fetch and display all API keys in an admin dashboard.
  • Retrieve a subset of API keys for pagination or batch processing.

Properties

Name Meaning
Additional Fields A collection of optional parameters to refine the query.
Limit Max number of results to return (default: 50).
Offset Number of results to skip before starting to collect the result set (default: 1).

Output

The node outputs a JSON array where each item represents an API key object as returned by the Meilisearch API. Each object typically includes fields such as:

{
  "uid": "string",
  "name": "string",
  "description": "string",
  "actions": ["*"],
  "indexes": ["*"],
  "expiresAt": "2024-12-31T23:59:59Z",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-06-01T00:00:00Z"
}
  • uid: Unique identifier for the API key.
  • name: Name of the API key.
  • description: Description of the API key.
  • actions: List of actions permitted by this key.
  • indexes: List of indexes accessible by this key.
  • expiresAt: Expiration date of the key.
  • createdAt: Creation timestamp.
  • updatedAt: Last update timestamp.

Dependencies

  • External Service: Requires access to a running Meilisearch instance.
  • API Key: Needs a valid Meilisearch API key with sufficient permissions.
  • n8n Credentials: Must configure the meilisearchApi credential in n8n, including the host URL and API key.

Troubleshooting

  • Invalid Credentials: If the API key or host URL is incorrect, you may receive authentication errors. Double-check your credentials in n8n.
  • Insufficient Permissions: The provided API key must have permission to list other keys; otherwise, access will be denied.
  • Connection Issues: Network problems or incorrect base URL can cause connection failures.
  • Limit/Offset Errors: Setting invalid values (e.g., negative numbers) for limit or offset may result in errors from the API.

Links and References

Discussion