Skip to content

Network Scan Networks

Operations for the Network Scan Networks service collection.

LanguageLast Update
Pythonv1.6.1
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
aggregate_networks
aggregate_networks
Returns “networks” aggregations
get_networks
get_networks
Get “networks” by their IDs
create_networks
create_networks
Create “networks” using provided specifications
delete_networks
delete_networks
Delete “networks” by their IDs
update_networks
update_networks
Update “networks” using provided specifications
query_networks
query_networks
Get “networks IDs” by filter

Returns “networks” aggregations

POST /netscan/aggregates/networks/GET/v1
Scope Network Scan: READ Consumes · Produces application/json
PEP 8 aggregate_networks
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 NetworkScanNetworks
falcon = NetworkScanNetworks(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.aggregate_networks(date_ranges=[{"key": "value"}],
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=[{"key": "value"}],
size=integer,
sort="string",
sub_aggregates=[{"key": "value"}],
time_zone="string",
type="string")
print(response)

Get “networks” by their IDs

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

Create “networks” using provided specifications

POST /netscan/entities/networks/v1
Scope Network Scan: WRITE Consumes · Produces application/json
PEP 8 create_networks
NameTypeData typeDescription
bodybodydictionaryFull body payload as JSON formatted dictionary.
namebodystringThe name which was given to the network
scanner_aidsbodyarrayThe set of scanners assigned to the network
scanner_assignment_typebodystringThe scanner assignment type for the network
subnetbodystringThe subnet included in the network
zone_idbodystringThe zone to which the network is assigned
from falconpy import NetworkScanNetworks
falcon = NetworkScanNetworks(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.create_networks(name="string",
scanner_aids=id_list,
scanner_assignment_type="string",
subnet="string",
zone_id="string")
print(response)

Delete “networks” by their IDs

DELETE /netscan/entities/networks/v1
Scope Network Scan: WRITE Consumes · Produces application/json
PEP 8 delete_networks
NameTypeData typeDescription
idsquerystring or list of stringsIDs of “networks” to be deleted (Min: 1, Max: 100)
from falconpy import NetworkScanNetworks
falcon = NetworkScanNetworks(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_networks(ids=id_list)
print(response)

Update “networks” using provided specifications

PATCH /netscan/entities/networks/v1
Scope Network Scan: WRITE Consumes · Produces application/json
PEP 8 update_networks
NameTypeData typeDescription
bodybodydictionaryFull body payload as JSON formatted dictionary.
idbodystringThe unique identifier of the network
namebodystringThe name which was given to the network
ownershipbodystringIndicates ownership of the network
scanner_aidsbodyarrayThe set of scanners assigned to the network
scanner_assignment_typebodystringThe scanner assignment type for the network
zone_idbodystringThe zone to which the network is assigned
from falconpy import NetworkScanNetworks
falcon = NetworkScanNetworks(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_networks(id="string",
name="string",
ownership="string",
scanner_aids=id_list,
scanner_assignment_type="string",
zone_id="string")
print(response)

Get “networks IDs” by filter

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