Skip to content

Get FalconScheduledScan

bk-cs edited this page Apr 28, 2023 · 2 revisions

Get-FalconScheduledScan

SYNOPSIS

Search for scheduled scans

DESCRIPTION

Requires 'On-demand scans (ODS): Read'.

PARAMETERS

Name Type Description Min Max Allowed Pipeline PipelineByName
Id String[] Scheduled scan identifier X X
Filter String Falcon Query Language expression to limit results
Sort String Property and direction to sort results id|asc
id|desc
description.keyword|asc
description.keyword|desc
status|asc
status|desc
schedule.start_timestamp|asc
schedule.start_timestamp|desc
schedule.interval|asc
schedule.interval|desc
created_on|asc
created_on|desc
created_by|asc
created_by|desc
last_updated|asc
last_updated|desc
Limit Int32 Maximum number of results per request
Offset Int32 Position to begin retrieving results
Detailed Switch Retrieve detailed information
All Switch Repeat requests until all available results are retrieved
Total Switch Display total result count instead of results

SYNTAX

Get-FalconScheduledScan [[-Filter] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] [-Detailed] [-All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconScheduledScan -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

REFERENCE

Endpoints

GET /ods/entities/scheduled-scans/v1
GET /ods/queries/scheduled-scans/v1

falconpy

query_scheduled_scans
get_scheduled_scans_by_scan_ids

USAGE

2023-04-25: PSFalcon v2.2.5

Clone this wiki locally