Meilisearch icon

Meilisearch

Consume Meilisearch API

Overview

This node integrates with the Meilisearch API, specifically allowing management of API keys among other resources. The "Delete An API Key" operation under the "Keys" resource enables users to remove an existing API key from their Meilisearch instance by specifying its unique identifier (UID). This is useful for maintaining security by revoking access tokens that are no longer needed or have been compromised.

Practical examples include:

  • Automatically deleting API keys that were created temporarily for a specific task.
  • Cleaning up unused or expired API keys as part of routine maintenance.
  • Revoking access when a user leaves a team or project.

Properties

Name Meaning
UID The unique identifier or key string of the API key to be deleted. This is required to specify which key should be removed.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or details about the deleted key. There is no binary output associated with this operation.

Dependencies

  • Requires connection to a Meilisearch instance via an API key credential.
  • The node expects the base URL of the Meilisearch server to be configured in the credentials.
  • Proper permissions on the API key used for authentication are necessary to perform key deletions.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent UID will likely result in an error indicating the key was not found.
    • Insufficient permissions on the API key credential can cause authorization errors.
    • Network connectivity problems to the Meilisearch server will prevent the operation from completing.
  • Error messages and resolutions:

    • "Key not found": Verify the UID is correct and the key exists.
    • "Unauthorized" or "Forbidden": Check that the API key used has rights to delete keys.
    • Timeout or network errors: Ensure the Meilisearch host URL is reachable and correct.

Links and References

Discussion