createRemoveQuarantineItemTask
This method creates a new task to remove items from quarantine.
Important
This method has been updated to version 1.1. For information applicable to version 1.0, refer to this section.
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 |
|---|---|---|---|
| Array | No | The list of quarantine items IDs. The maximum number of items that can be removed once is 100. The ID must belong to a quarantine item that the user has permission to access. |
Return value
This method returns an array of parent task ids of the created tasks.
Example
Request:
{
"params": {
"quarantineItemsIds": [
"63896b87b7894d0f367b23c6",
"65896b87b7894d0f367b23c6"
]
},
"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 |
|---|---|---|---|
| Array | No | The list of quarantine items IDs. The maximum number of items that can be removed once is 100. |
Return value
This method returns a Boolean which is True when the task was successfully created.
Example
Request:
{
"params": {
"quarantineItemsIds": [
"63896b87b7894d0f367b23c6",
"65896b87b7894d0f367b23c6"
]
},
"jsonrpc": "2.0",
"method": "createRemoveQuarantineItemTask",
"id": "5399c9b5-0b46-45e4-81aa-889952433d86"
} Response:
{
"id": "5399c9b5-0b46-45e4-81aa-889952433d86",
"jsonrpc":"2.0",
"result": True
}