Delete Task API

Introduced 3.9

Use the Delete Task API to delete the stored result of a completed task. For example, when you run a supported operation and set wait_for_completion=false, OpenSearch stores the task result so that you can retrieve it later by using the Get Task API. When you no longer need the result, delete it to free the associated storage.

The Delete Task API does not cancel or delete a running task. To stop a running task, use the Cancel Tasks API.

Endpoints

DELETE /_tasks/{task_id}

Path parameters

The following table lists the available path parameters.

Example request

The following request deletes the stored result for task JzrCxdtFTCO_RaINw8ckNA:54321:

DELETE /_tasks/JzrCxdtFTCO_RaINw8ckNA:54321

response = client.tasks.delete(
  task_id = "JzrCxdtFTCO_RaINw8ckNA:54321"
)

Example response

OpenSearch responds with an acknowledgment after deleting the stored result:

{
  "acknowledged": true
}

After a successful deletion, the Get Task API returns a 404 Not Found response for the task.

Parent and child tasks

You cannot delete a stored task result while it has running child tasks or stored child task results. In a hierarchy of stored task results, delete the results from the leaves toward the root. For example, delete a grandchild result before its parent result, and then delete the root result.

OpenSearch returns a 409 Conflict response if the task has running child tasks or stored child task results.

Response codes

The following table lists common response codes.

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: cluster:admin/tasks/delete.