createAddFileToQuarantineTask
This method creates a new task to add a file to quarantine.
Important
This main section of this article article contains information for the 1.1 version of the method. You can find information for version 1.0 here.
Parameters
Parameter | Type | Optional | Description |
|---|---|---|---|
| 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. |
| 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 an array of parent task ids of the created tasks.
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": [
"652feab6b9684f3ba80685d5",
"652feab6b9684f3ba80685d5"
]
}Version 1.0
Parameters
Parameter | Type | Optional | Description |
|---|---|---|---|
| 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. |
| 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
}