PARTNERS

createAddFileToQuarantineTask

This method creates a new task to add a file to quarantine.

Parameters

Parameter

Type

Optional

Description

endpointIds

Array

No

A list with the IDs of target endpoints. You can specify maximum 100 targets at once. Only endpoints with security agents in Detection and prevention mode and active EDR Sensor module are valid targets.

filePath

String

No

The absolute file path on disk. This path can be at most 4096 characters in length and should have the format suitable to the target endpoint's operating system.

Return value

This method returns a Boolean which is True when the task was successfully created.

Example

Request:

  {
       "params": {
           "endpointIds": [
               "63896b87b7894d0f367b23c6",
               "65896b87b7894d0f367b23c6"
           ],
           "filePath": "Z:\\path\\to\\file"
       },
       "jsonrpc": "2.0",
       "method": "createAddFileToQuarantineTask",
       "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
  }   

Response:

  {
      "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
      "jsonrpc":"2.0",
      "result": True
  }