Actions24
- Documents Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Overview
This node operation allows users to delete tasks from Meilisearch based on various filtering criteria. It is useful in scenarios where you want to clean up or remove specific indexing or search tasks that have been queued, started, finished, or canceled within Meilisearch.
Practical examples include:
- Deleting all tasks related to a specific index.
- Removing tasks of certain types or statuses (e.g., failed or canceled tasks).
- Cleaning up tasks enqueued before or after a certain date/time to manage task history.
Properties
| Name | Meaning |
|---|---|
| UIDs | Comma delimited list of Task unique identifiers (UIDs) to filter which tasks to delete. |
| Index UIDs | Comma delimited list of Index unique identifiers to filter tasks associated with those indexes. |
| Statuses | Comma delimited list of Task statuses to filter by (e.g., enqueued, processing, succeeded). |
| Types | Comma delimited list of Task types to filter by (e.g., indexing, deletion). |
| Canceled By | Comma delimited list of Task UIDs that canceled other tasks, used to filter tasks accordingly. |
| Before Enqueued At | Filter tasks enqueued before this date/time (ISO 8601 format). |
| After Enqueued At | Filter tasks enqueued after this date/time (ISO 8601 format). |
| Before Started At | Filter tasks started before this date/time (ISO 8601 format). |
| After Started At | Filter tasks started after this date/time (ISO 8601 format). |
| Before Finished At | Filter tasks finished before this date/time (ISO 8601 format). |
| After Finished At | Filter tasks finished after this date/time (ISO 8601 format). |
These fields are provided as additional filters to precisely select which tasks should be deleted.
Output
The output JSON contains the response from the Meilisearch API regarding the deletion request. Typically, it includes information about the deletion status or confirmation of the tasks removed.
No binary data is output by this operation.
Dependencies
- Requires an active connection to a Meilisearch instance.
- Needs an API key credential for authenticating requests to the Meilisearch API.
- The base URL of the Meilisearch host must be configured in the node credentials.
Troubleshooting
Common issues:
- Providing invalid or malformed UIDs or dates may cause the API to reject the request.
- Attempting to delete tasks without proper permissions or an invalid API key will result in authentication errors.
- Filtering with no matching tasks will result in no deletions but typically no error.
Error messages:
- Authentication errors indicate missing or incorrect API credentials; verify and update your API key.
- Validation errors usually point to incorrect filter formats; ensure comma-separated values have no extra spaces and dates are valid ISO strings.
- Network or connection errors suggest issues reaching the Meilisearch server; check network connectivity and host URL configuration.