Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Keys → Update An API Key

AI-generated

Overview

This node operation updates an existing API key in Meilisearch. It allows users to modify the key's name and description by specifying the key's UID. Additionally, it supports waiting for the update task to complete with configurable polling options, including exponential backoff and timeout settings. This is useful for managing API keys programmatically within workflows, ensuring keys are updated as needed and confirming the update's success before proceeding.

Use Case Examples

  1. Updating the name and description of an existing API key by providing its UID.
  2. Waiting for the update task to complete before continuing the workflow, with exponential backoff enabled to reduce API calls.
  3. Setting a fixed polling interval and timeout to control how long the node waits for the update task to finish.

Properties

Name Meaning
UID The unique identifier or key of the API key to update. Required to specify which key to update.
Name The new name to assign to the API key. Optional field to update the key's name.
Description The new description for the API key. Optional field to update the key's description.
Wait for Completion Whether to wait for the update task to complete before returning. If enabled, the node polls the task status until it succeeds, fails, or is canceled.
Use Exponential Backoff If enabled, the polling interval increases gradually to reduce API calls during task status checks.
Polling Interval (ms) Fixed interval in milliseconds between polling requests when exponential backoff is disabled.
Initial Polling Interval (ms) Starting interval in milliseconds between polling requests when exponential backoff is enabled. The interval increases by 1.5x every 5 attempts.
Max Polling Interval (ms) Maximum interval in milliseconds between polling requests when exponential backoff is enabled. The interval will not exceed this value.
Timeout (seconds) Maximum time in seconds to wait for the update task to complete before timing out.

Output

JSON

  • status - The status of the update task, e.g., succeeded, failed, or canceled.
  • taskUid - The unique identifier of the update task.
  • type - The type of task performed, e.g., updateKey.
  • details - Additional details about the task result or error information.

Dependencies

  • Meilisearch API authentication token

Troubleshooting

  • If the node times out waiting for task completion, increase the timeout setting or check the Meilisearch server status.
  • Ensure the UID provided is correct and corresponds to an existing API key; otherwise, the update will fail.
  • If polling is enabled but no task UID is returned, the node will return the immediate response without waiting.
  • Check API credentials and permissions if authentication errors occur.

Links

Discussion