Restores a file from the quarantine area using the specified quarantine ID.
Supported Platforms
Windows and macOS
Input Parameters
The following input parameters are available for this audit.
Quarantine ID
Details | Values | Description |
|---|---|---|
Platform | Windows | Windows environments |
Format | String | Valid values are a string of text. |
Required? | yes | This parameter is required. |
Repeatable? | no | This parameter can be specified only once per audit request. It cannot be repeated. |
Valid Values | Specify a valid quarantine ID. The file associated with the quarantine ID is restored from the quarantine area. |
Restore path
Details | Values | Description |
|---|---|---|
Platform | Windows | Windows environments |
Format | String | Valid values are a string of text. |
Required? | no | This parameter is not required. |
Repeatable? | no | This parameter can be specified only once per audit request. It cannot be repeated. |
Valid Values | Specify the path where the file should be restored. If no path is provided, the file is restored to its original location. |
Force
Details | Values | Description |
|---|---|---|
Platform | Windows | Windows environments |
Format | Boolean | Valid values are Boolean values. |
Required? | no | This parameter is not required. |
Repeatable? | no | This parameter can be specified only once per audit request. It cannot be repeated. |
Valid Values | Use Boolean values to indicate whether to overwrite an existing file with the same name at the restore path. A Boolean true value overwrites the existing file. The default is a Boolean false value. Existing files are not overwritten and an error message is provided. |
Purge
Details | Values | Description |
|---|---|---|
Platform | Windows | Windows environments |
Format | Boolean | Valid values are Boolean values. |
Required? | no | This parameter is not required. |
Repeatable? | no | This parameter can be specified only once per audit request. It cannot be repeated. |
Valid Values | Use Boolean values to indicate whether to purge the file from quarantine after restoring it successfully. A Boolean true value will purge the file. The default is a Boolean true value. The file is purged after it is successfully restored. |