Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Indexes → Delete Index

AI-generated

Overview

This node operation deletes an index in Meilisearch by its UID (unique identifier). It is useful for managing search indexes by removing those that are no longer needed, helping to maintain an organized and efficient search environment. For example, you might delete an outdated product index in an e-commerce application to free up resources.

Use Case Examples

  1. Deleting an index named 'products' to remove all associated search data.
  2. Removing a temporary index created for a specific campaign after its completion.

Properties

Name Meaning
UID The unique identifier (name) of the index to be deleted.
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 waiting for completion, whether to use exponential backoff for polling intervals to reduce API calls.
Polling Interval (ms) Fixed interval between polling requests in milliseconds, used if exponential backoff is disabled.
Initial Polling Interval (ms) Starting interval between polling requests in milliseconds, increases by 1.5x every 5 attempts if exponential backoff is enabled.
Max Polling Interval (ms) Maximum interval between polling requests when using exponential backoff.
Timeout (seconds) Maximum time to wait for task completion in seconds (default 5 minutes).

Output

JSON

  • status - The status of the deletion task (e.g., succeeded, failed, canceled).
  • taskUid - The unique identifier of the deletion task.
  • details - Additional details about the task result or error if any.

Dependencies

  • Requires Meilisearch API credentials for authentication.

Troubleshooting

  • If the node times out waiting for task completion, increase the timeout setting or disable waiting for completion.
  • If the specified UID does not exist, the API will return an error indicating the index was not found.
  • Ensure the API credentials have sufficient permissions to delete indexes.

Links

Discussion