Delete task
DELETE/api/tasks/:task_id
Delete finished task.
Tasks in the Virtual Appliance expire and get deleted automatically after a configurable timeout, along with any related output files (e.g., Denoiser tasks). You don't generally need to delete tasks manually, unless you hit the limit of the output storage and need to free up the storage to enable processing other tasks that produce output files. Input files are deleted automatically after processing and need no special treatment.
Features
- Only tasks in the following states can be deleted:
done,rejected,failed.
Request
Responses
- 204
- 400
- 404
- 409
- 422
- 429
Response of successful task deletion. Doesn't contain any body.
Request payload data was invalid and could not be parsed.
The requested task does not exist.
The provided task_id may be wrong or the task may have expired already.
The task requested for deletion has not finished yet.
Error during validation of request payload data occurred.
Request rate limit exceeded.
The request may be retried after a while. The following response headers may be checked for details: retry-after, x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset.
Response Headers
Header indicates how long the user agent should wait before making a follow-up request.
Size of the current rate limiting window.
Remaining number of requests in the current rate limiting window.
Time at which the current rate limiting window resets (in UTC epoch).