Skip to content

Network Scan Scanners

Operations for the Network Scan Scanners service collection.

LanguageLast Update
Pythonv1.6.1
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
aggregate_scanners
aggregate_scanners
Returns “scanners” aggregations
get_scanners
get_scanners
Get “scanners” by their IDs
update_scanners
update_scanners
Update “scanners” using provided specifications
query_scanners
query_scanners
Get “scanners IDs” by filter

Returns “scanners” aggregations

POST /netscan/aggregates/scanners/GET/v1
Scope Network Scan: READ Consumes · Produces application/json
PEP 8 aggregate_scanners
NameTypeData typeDescription
bodybodydictionaryFull body payload as JSON formatted dictionary.
date_rangesbodyarray
excludebodystring
extended_boundsbodyobject
fieldbodystring
filterbodystring
filters_specbodyobject
frombodyinteger
includebodystring
intervalbodystring
max_doc_countbodyinteger
min_doc_countbodyinteger
missingbodystring
namebodystring
percentsbodyarray
qbodystring
rangesbodyarray
sizebodyinteger
sortbodystring
sub_aggregatesbodyarray
time_zonebodystring
typebodystring
from falconpy import NetworkScanScanners
falcon = NetworkScanScanners(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
extended_bounds = {
"max": "string",
"min": "string"
}
filters_spec = {
"filters": {},
"other_bucket": boolean,
"other_bucket_key": "string"
}
ranges = [
{
"from": integer,
"to": integer
}
]
sub_aggregates = [
{
"date_ranges": [
{
"from": "string",
"to": "string"
}
],
"exclude": "string",
"extended_bounds": {
"max": "string",
"min": "string"
},
"field": "string",
"filter": "string",
"filters_spec": {
"filters": {},
"other_bucket": boolean,
"other_bucket_key": "string"
},
"from": integer,
"include": "string",
"interval": "string",
"max_doc_count": integer,
"min_doc_count": integer,
"missing": "string",
"name": "string",
"percents": ["string"],
"q": "string",
"ranges": [
{
"from": integer,
"to": integer
}
],
"size": integer,
"sort": "string",
"sub_aggregates": [
{
"date_ranges": ["string"],
"exclude": "string",
"extended_bounds": {},
"field": "string",
"filter": "string",
"filters_spec": {},
"from": integer,
"include": "string",
"interval": "string",
"max_doc_count": integer,
"min_doc_count": integer,
"missing": "string",
"name": "string",
"percents": ["string"],
"q": "string",
"ranges": ["string"],
"size": integer,
"sort": "string",
"sub_aggregates": ["string"],
"time_zone": "string",
"type": "string"
}
],
"time_zone": "string",
"type": "string"
}
]
response = falcon.aggregate_scanners(date_ranges=date_ranges,
exclude="string",
extended_bounds=extended_bounds,
field="string",
filter="string",
filters_spec=filters_spec,
from=integer,
include="string",
interval="string",
max_doc_count=integer,
min_doc_count=integer,
missing="string",
name="string",
percents=["string"],
q="string",
ranges=ranges,
size=integer,
sort="string",
sub_aggregates=sub_aggregates,
time_zone="string",
type="string")
print(response)

Get “scanners” by their IDs

GET /netscan/entities/scanners/v1
Scope Network Scan: READ Consumes · Produces application/json
PEP 8 get_scanners
NameTypeData typeDescription
idsquerystring or list of stringsIDs of “scanners” to be retrieved (Min: 1, Max: 100)
from falconpy import NetworkScanScanners
falcon = NetworkScanScanners(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_scanners(ids=id_list)
print(response)

Update “scanners” using provided specifications

PATCH /netscan/entities/scanners/v1
Scope Network Scan: WRITE Consumes · Produces application/json
PEP 8 update_scanners
NameTypeData typeDescription
bodybodydictionaryFull body payload as JSON formatted dictionary.
actionbodystringThe action to take on the provided set of scanners
aidsbodyarrayThe AIDs of scanners to act on
from falconpy import NetworkScanScanners
falcon = NetworkScanScanners(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.update_scanners(action="string", aids=id_list)
print(response)

Get “scanners IDs” by filter

GET /netscan/queries/scanners/v1
Scope Network Scan: READ Consumes · Produces application/json
PEP 8 query_scanners
NameTypeData typeDescription
offsetqueryintegerAn 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
limitqueryintegerThe number of “scanners IDs” to return in this response (Min: 1, Max: 100, Default: 100)
sortquerystringSort “scanners” by their properties. A single sort field is allowed
filterquerystringSearch for “scanners” by providing an FQL filter
from falconpy import NetworkScanScanners
falcon = NetworkScanScanners(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_scanners(offset="string",
limit="string",
sort="string",
filter="string")
print(response)