Skip to content

Network Scan Scans

Operations for the Network Scan Scans service collection.

LanguageLast Update
Pythonv1.6.5
PowerShell
Gov0.22.0
TypeScriptv0.6.0
Rustv0.7.1
Rubyv1.4.0


OperationDescription
aggregate-scansMixin0
aggregate_scans
Returns “scans” aggregations
create-scans
create_scans
Create “scans” using provided specifications
delete-scans
delete_scans
Delete “scans” by their IDs
get-scans
get_scans
Get “scans” by their IDs
query-scansMixin0
query_scans
Get “scans IDs” by filter
update-scans
update_scans
Update “scans” using provided specifications

Returns “scans” aggregations

Method POST
Route /netscan/aggregates/scans/GET/v1
Scope Network scanning: READ
PEP 8 aggregate_scans
body body · dictionary
Full body payload as JSON formatted dictionary.
date_ranges body · array
Array of date range specifications for date-based aggregations.
exclude body · string
Fields to exclude from the aggregation.
extended_bounds body · object
field body · string
The field to aggregate on.
filter body · string
FQL query to filter the data before aggregating.
filters_spec body · object
from body · integer
Starting index for the aggregation.
include body · string
Fields to include in the aggregation.
interval body · string
Time interval for date histogram aggregations (e.g., day, week, month)
max_doc_count body · integer
Maximum document count for bucket inclusion.
min_doc_count body · integer
Minimum document count for bucket inclusion.
missing body · string
The value to use for documents missing the aggregation field.
name body · string
The name of the aggregation query.
percents body · array
q body · string
Full-text search query.
ranges body · array
Numeric range specifications for range aggregations.
size body · integer
The maximum number of results to return per aggregate.
sort body · string
The field to sort aggregate results on.
sub_aggregates body · array
Nested sub-aggregation specifications.
time_zone body · string
The time zone to use for date aggregations.
type body · string
The type of aggregate query to perform.
from falconpy import NetworkScanScans
falcon = NetworkScanScans(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
ranges = [
{
"From": "integer",
"To": "integer"
}
]
sub_aggregates = [
{}
]
response = falcon.aggregate_scans(date_ranges=date_ranges,
exclude="string",
field="string",
filter="string",
from=integer,
include="string",
interval="string",
max_doc_count=integer,
min_doc_count=integer,
missing="string",
name="string",
q="string",
ranges=ranges,
size=integer,
sort="string",
sub_aggregates=sub_aggregates,
time_zone="string",
type="string")
print(response)
[
{
"buckets": [],
"doc_count_error_upper_bound": 0,
"hits": {},
"name": "string",
"sum_other_doc_count": 0
}
]


Create “scans” using provided specifications

Method POST
Route /netscan/entities/scans/v1
Scope Network scanning: WRITE
PEP 8 create_scans
body body · dictionary
Full body payload as JSON formatted dictionary.
block_windows body · object
Block Windows configuration attached to the scan
credentialed body · boolean
Indicates if the scan is credentialed
credentials body · object
The credentials for this scan
description body · string
Description of the scan
fragile_device_detection body · boolean
Indicates if the scan includes fragile-device detection
name body · string
Name of the scan
scheduling body · object
Scheduling configuration attached to the scan
target_asset body · object
The target asset for this scan
target_asset_filter body · object
The target asset filter for this scan
target_external_ip body · object
The target external IP for this scan
target_ip body · object
The target IP for this scan
target_type body · string
The type of the target for this scan
Available values (5)
ipassetasset_filter
asset_vulnexternal_ip
template_id body · string
Template identifier for the scan
from falconpy import NetworkScanScans
falcon = NetworkScanScans(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.create_scans(block_windows={},
credentialed=boolean,
credentials={},
description="string",
fragile_device_detection=boolean,
name="string",
scheduling={},
target_asset={},
target_asset_filter={},
target_external_ip={},
target_ip={},
target_type="string",
template_id="string")
print(response)
[
{
"block_windows": {},
"cid": "string",
"created_by": "string",
"created_timestamp": "string",
"credentialed": false,
"credentials": {},
"description": "string",
"fragile_device_detection": false,
"frequency": "string",
"id": "string",
"last_run_timestamp": "string",
"last_scan_status": "string",
"name": "string",
"next_run_timestamp": "string",
"scheduling": {},
"target_asset": {},
"target_asset_filter": {},
"target_external_ip": {},
"target_ip": {},
"target_type": "string",
"template_id": "string",
"type": "string",
"updated_by": "string",
"updated_timestamp": "string"
}
]


Delete “scans” by their IDs

Method DELETE
Route /netscan/entities/scans/v1
Scope Network scanning: WRITE
PEP 8 delete_scans
ids query · string or list of strings
IDs of “scans” to be deleted (Min: 1, Max: 100)
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import NetworkScanScans
falcon = NetworkScanScans(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_scans(ids=id_list)
print(response)
[
"string"
]


Get “scans” by their IDs

Method GET
Route /netscan/entities/scans/v1
Scope Network scanning: READ
PEP 8 get_scans
ids query · string or list of strings
IDs of “scans” to be retrieved (Min: 1, Max: 100)
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import NetworkScanScans
falcon = NetworkScanScans(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_scans(ids=id_list)
print(response)
[
{
"block_windows": {},
"cid": "string",
"created_by": "string",
"created_timestamp": "string",
"credentialed": false,
"credentials": {},
"description": "string",
"fragile_device_detection": false,
"frequency": "string",
"id": "string",
"last_run_timestamp": "string",
"last_scan_status": "string",
"name": "string",
"next_run_timestamp": "string",
"scheduling": {},
"target_asset": {},
"target_asset_filter": {},
"target_external_ip": {},
"target_ip": {},
"target_type": "string",
"template_id": "string",
"type": "string",
"updated_by": "string",
"updated_timestamp": "string"
}
]


Get “scans IDs” by filter

Method GET
Route /netscan/queries/scans/v1
Scope Network scanning: READ
PEP 8 query_scans
offset query · integer
An offset used with the limit parameter to manage pagination of results. On your first request, don’t provide an offset. On subsequent requests, add previous offset with the previous limit to continue from that place in the results
limit query · integer
The number of “scans IDs” to return in this response (Min: 1, Max: 100, Default: 100)
sort query · string
Sort “scans” by their properties. A single sort field is allowed
filter query · string
Search for “scans” by providing an FQL filter
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import NetworkScanScans
falcon = NetworkScanScans(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_scans(offset=integer,
limit=integer,
sort="string",
filter="string")
print(response)
[
"string"
]


Update “scans” using provided specifications

Method PATCH
Route /netscan/entities/scans/v1
Scope Network scanning: WRITE
PEP 8 update_scans
body body · dictionary
Full body payload as JSON formatted dictionary.
block_windows body · object
Block Windows configuration attached to the scan
credentialed body · boolean
Indicates if the scan is credentialed
credentials body · object
The credentials for this scan
description body · string
Description of the scan
fragile_device_detection body · boolean
Indicates if the scan includes fragile device detection
id body · string
ID of the scan
name body · string
Name of the scan
scheduling body · object
Scheduling configuration attached to the scan
target_asset body · object
The target asset associated with this scan
target_asset_filter body · object
The target asset filter associated with this scan
target_external_ip body · object
The target external IP associated with this scan
target_ip body · object
The target IP associated with this scan
target_type body · string
The type of the target scan
Available values (5)
ipassetasset_filter
asset_vulnexternal_ip
template_id body · string
Template ID of the scan
from falconpy import NetworkScanScans
falcon = NetworkScanScans(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.update_scans(block_windows={},
credentialed=boolean,
credentials={},
description="string",
fragile_device_detection=boolean,
id="string",
name="string",
scheduling={},
target_asset={},
target_asset_filter={},
target_external_ip={},
target_ip={},
target_type="string",
template_id="string")
print(response)
[
{
"block_windows": {},
"cid": "string",
"created_by": "string",
"created_timestamp": "string",
"credentialed": false,
"credentials": {},
"description": "string",
"fragile_device_detection": false,
"frequency": "string",
"id": "string",
"last_run_timestamp": "string",
"last_scan_status": "string",
"name": "string",
"next_run_timestamp": "string",
"scheduling": {},
"target_asset": {},
"target_asset_filter": {},
"target_external_ip": {},
"target_ip": {},
"target_type": "string",
"template_id": "string",
"type": "string",
"updated_by": "string",
"updated_timestamp": "string"
}
]