WAwatchguard

Scans devices immediately.

Starts a task to scan the specified devices immediately.

post/api/v1/accounts/{accountId}/immediatescan

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud account ID.

Request body

device_idsstring[]
task_namestring

Name of the scan task.

task_descriptionstring

Description of the scan task.

scan_scope0 | 1 | 2

Scope of the scan task.

  • 0: Whole computer
  • 1: Critical areas
  • 2: Specified items
specified_items_to_scanstring[]

List of specific locations or items to scan. All folders and files in the specified locations are scanned. Works only when scan_scope is 2.

detect_hacking_toolsboolean

Indicates whether to detect hacking tools.

detect_suspicious_filesboolean

Indicates whether to detect suspicious files.

scan_compressed_filesboolean

Indicates whether to scan compressed files. This decompresses compressed files and scans their contents.

apply_exclusions_on_scanboolean

Indicates whether to exclude items from the scan, such as specific files, files with a specific extension, or a specific directory.

extensions_to_excludestring[]

List of file extensions to exclude from the scan. Works only when apply_exclusions_on_scan is true.

files_to_excludestring[]

List of file names (with extensions) to exclude from the scan. Works only when apply_exclusions_on_scan is true.

folders_to_excludestring[]

List of folders to exclude from the scan. You must include the full path. Works only when apply_exclusions_on_scan is true.

execution_window_expirationstring

Time period in which the scan must run before it times out. Default is 7 days.

Example request

{
  "device_ids": [
    "00ab3e54-7bb7-4bd3-r0lo-237a9d191a44, 287324d8-194f-4f5a-a7ad-e2480d5ad1b2"
  ],
  "task_name": "Routine scan.",
  "task_description": "Windows 8 machines only.",
  "detect_hacking_tools": true,
  "scan_compressed_files": true,
  "apply_exclusions_on_scan": true,
  "folders_to_exclude": [
    "D:/shared_drive/documents"
  ],
  "execution_window_expiration": "8.07:06:05 specifies 8 days, 7 hours, 6 minutes, and 5 seconds."
}

Response

OK

task_idstring uuid

ID of the completed scan task.

no_executed_by_not_found_device_idsstring uuid

If the action could not be completely executed, the list of device ids not found (not executed) will be returned here.

Example response

{
  "task_id": "12a345a6-a789-0123-a4aa-56a7890a12a3",
  "no_executed_by_not_found_device_ids": "12a345a6-a789-0123-a4aa-56a7890a12a3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.