Start FalconScan
Start an on-demand scan
Requires 'On-demand scans (ODS): Write'.
| Name | Type | Description | Min | Max | Allowed | Pipeline | PipelineByName |
|---|---|---|---|---|---|---|---|
| FilePath | String[] | File path(s) to scan | |||||
| SensorDetection | String | On-sensor machine-learning detection level |
disabledcautiousmoderateaggressiveextra_aggressive
|
||||
| SensorPrevention | String | On-sensor machine-learning prevention level |
disabledcautiousmoderateaggressiveextra_aggressive
|
||||
| CloudDetection | String | Cloud-based machine-learning detection level |
disabledcautiousmoderateaggressiveextra_aggressive
|
||||
| CloudPrevention | String | Cloud-based machine-learning prevention level |
disabledcautiousmoderateaggressiveextra_aggressive
|
||||
| CloudPupDetection | String | Cloud-based machine-learning PUP detection level |
disabledcautiousmoderateaggressiveextra_aggressive
|
||||
| CloudPupPrevention | String | Cloud-based machine-learning PUP prevention level |
disabledcautiousmoderateaggressiveextra_aggressive
|
||||
| CpuPriority | String | Maximum CPU utilization |
up_to_1up_to_25up_to_50up_to_75up_to_100
|
||||
| ScanExclusion | String[] | File path(s) to exclude, in glob syntax | |||||
| ScanInclusion | String[] | File path(s) to include, in glob syntax | |||||
| Quarantine | Boolean | Quarantine malicious files | |||||
| MaxFileSize | Int32 | Maximum file size, in MB | |||||
| Notification | Boolean | ||||||
| MaxDuration | Int32 | Allowable scan duration, in hours | 0 |
24 |
|||
| PauseDuration | Int32 | Allowable pause duration, in hours | 0 |
24 |
|||
| Description | String | On-demand scan description | |||||
| GroupId | String[] | Host Group identifier | |||||
| Id | String[] | Host identifier | X | X |
Start-FalconScan [-FilePath] <String[]> [-SensorDetection] <String> [-SensorPrevention] <String> [-CloudDetection] <String> [-CloudPrevention] <String> [-CloudPupDetection] <String> [-CloudPupPrevention] <String> [-CpuPriority] <String> [[-ScanExclusion] <String[]>] [[-ScanInclusion] <String[]>] [[-Quarantine] <Boolean>] [[-MaxFileSize] <Int32>] [[-Notification] <Boolean>] [[-MaxDuration] <Int32>] [[-PauseDuration] <Int32>] [[-Description] <String>] [-GroupId <String[]>] [-Id <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]POST /ods/entities/scans/v1
2025-09-19: PSFalcon v2.2.9