Skip to main content

deleteTask

You can use this method to delete a specific task, based on its ID.

To delete a task, it must meet these requirements:

  • The task must not be in progress.

  • The task type must be one of the following:

    • 1 - Scan task.

    • 7 - Reconfigure task

    • 9 - Remove quarantine task.

    • 10 - Restore quarantine task.

    • 14 - Remove all quarantine task.

    • 15 - Remove all quarantine exchange task.

    • 16 - Isolate task

    • 17 - Restore from isolation task

    • 18 - Remove quarantine exchange task.

    • 19 - Restore quarantine exchange task.

    • 20 - Add quarantine task.

Parameters

Parameter

Description

Included in request

Type

Values

taskId

The ID of the task you want to retrieve the status of.

Mandatory

String

No additional requirements.

Return value

Attribute

Description

Type

result

Returns true if the request was successful.

String

Example

Request:

{
  "params": {
    "taskId": "21a295eeb1a43d8b497b23b7",
  },
  "jsonrpc": "2.0",
  "method": "deleteTask",
  "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
}

Response:

{
  "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
  "jsonrpc":"2.0",
  "result": true
}
In this section: