Deleting Sandbox task

Kaspersky Research Sandbox provides an API to delete a Sandbox task.

Request

Request method: DELETE

Endpoint: https://<server name>/api/v1/sandbox/tasks/{task ID}

Parameters

Deleting task parameters

Parameter	Data type	Occurrence	Description
`task_id`	string	Required	Object execution task ID (GUID) that you want to delete.

cURL command sample:

$ curl --user <user name> --request DELETE 'https://<server name>/api/v1/sandbox/tasks/<task ID>'

You will be asked to enter your password. The password is not displayed while you type it.

Responses

Endpoint deletes the specified execution task.

200 OK

Sandbox task is deleted successfully.

400 Bad Request

Failed to delete Sandbox task due to incorrect query.

400 Bad Request response parameters

Parameter	Data type	Description
`code`	string	Error ID.
`message`	string	Error description.
`meta`	string	Additional information, if available.

Error examples:

Incorrect task_id parameter:

{"code":6,"message":"task not found"}

Incorrect task_id parameter format:

{"code":29,"message":"bad task id"}

401 Unauthorized

Failed to delete Sandbox task due to incorrect user credentials.

404 Not Found

Task with specified ID not found.

Error examples:

Task was previously deleted:

404. {"code":7,"message":"task deleted","meta":"task has already been deleted"}

Specified task ID does not exist:

404. {"code":6,"message":"task not found"}

500 Internal Server Error

Failed to delete a Sandbox task due to an internal server error.