createEmptyQuarantineTask
This method creates a new task to empty the 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.
Services
This method requires you to place the {service} name in the API URL. The allowed services are:
exchange, for "Security for Exchange"computers, for "Computers and Virtual Machines"
For example, the request URL for the computers service is:
https://YOUR-HOSTNAME/api/v1.0/jsonrpc/quarantine/computers
Parameters
Parameter | Type | Optional | Description |
|---|---|---|---|
| Boolean | Yes | Include the quarantined items for child companies. The default value for this parameter is false. |
Return value
This method returns an array of parent task ids of the created tasks.
Example
Request:
{
"params": {
"includeSubCompanies": true
},
"jsonrpc": "2.0",
"method": "createRemoveQuarantineItemTask",
"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 |
|---|---|---|---|
| Boolean | Yes | Include the quarantined items for child companies. The default value for this parameter is false. |
Return value
This method returns a Boolean which is True when the task was successfully created.
Example
Request:
{
"params": {
"includeSubCompanies": true
},
"jsonrpc": "2.0",
"method": "createEmptyQuarantineTask",
"id": "5399c9b5-0b46-45e4-81aa-889952433d86"
}Response:
{
"id": "5399c9b5-0b46-45e4-81aa-889952433d86",
"jsonrpc":"2.0",
"result": True
}