Actions24
- Documents Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Overview
This node integrates with the Meilisearch API, specifically allowing users to manage API keys among other resources. The "Update An API Key" operation under the "Keys" resource enables updating properties of an existing API key such as its name and description. This is useful for maintaining clear identification and documentation of API keys used in your Meilisearch instance.
Practical scenarios include:
- Renaming an API key to reflect a change in its purpose.
- Adding or updating a description to clarify the key's usage context.
- Managing access control by keeping key metadata up to date without regenerating keys.
Properties
| Name | Meaning |
|---|---|
| UID | The unique identifier or key string of the API key to update. Required for this action. |
| Name | New name to assign to the API key. Optional; if provided, updates the key's name. |
| Description | New description text for the API key. Optional; if provided, updates the key's description. |
Output
The node outputs JSON data representing the updated API key object returned from the Meilisearch API. This typically includes fields such as the key's UID, name, description, creation date, and any associated permissions or indexes (depending on Meilisearch's API response structure).
No binary data output is involved in this operation.
Dependencies
- Requires connection to a Meilisearch instance via its REST API.
- Needs an API authentication token credential configured in n8n to authorize requests.
- The base URL for the Meilisearch host must be set in the credentials configuration.
Troubleshooting
- Invalid UID: If the UID provided does not correspond to an existing API key, the API will return an error indicating the key was not found. Verify the UID is correct.
- Authentication errors: Ensure the API authentication token is valid and has sufficient permissions to update keys.
- Empty update: If neither "Name" nor "Description" is provided, the request may fail or have no effect. Provide at least one field to update.
- Network issues: Confirm that the Meilisearch host URL is reachable from the n8n environment.