Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Keys → Delete An API Key

AI-generated

Overview

This node operation deletes an API key in Meilisearch by specifying the key's UID. It supports waiting for the deletion task to complete, with options for polling intervals and exponential backoff to efficiently check the task status. This is useful for managing API keys programmatically, such as revoking access or cleaning up unused keys.

Use Case Examples

  1. Deleting an API key by its UID to revoke access.
  2. Automating API key management by deleting keys after certain conditions are met.

Properties

Name Meaning
UID The unique identifier or key of the API key to be deleted, required to specify which key to delete.
Wait for Completion Whether to wait for the deletion 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 for checking task status increases gradually to reduce API calls. If disabled, a fixed polling interval is used.
Polling Interval (ms) Fixed interval between polling requests in milliseconds, used when exponential backoff is disabled.
Initial Polling Interval (ms) Starting interval between polling requests in milliseconds, which increases by 1.5x every 5 attempts when exponential backoff is enabled.
Max Polling Interval (ms) Maximum interval between polling requests in milliseconds; exponential backoff will not exceed this value.
Timeout (seconds) Maximum time to wait for task completion in seconds before timing out (default is 5 minutes).

Output

JSON

  • status - The status of the deletion task, e.g., succeeded, failed, or canceled.
  • taskUid - The unique identifier of the task that performs the deletion.
  • type - The type of task performed, here it would be related to key deletion.
  • details - Additional details about the task execution.

Dependencies

  • Meilisearch API key credential

Troubleshooting

  • If the node times out waiting for task completion, increase the timeout setting or check the Meilisearch server status.
  • If the UID is incorrect or the key does not exist, the API will return an error indicating the key was not found.
  • Ensure the Meilisearch API credentials are correctly configured to avoid authentication errors.

Links

Discussion