Skip to content
CrowdStrike Developer Center

Network Scan Scanners

Operations for the Network Scan Scanners service collection.

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

Table of Contents

Section titled “Table of Contents”
OperationDescription
aggregate-scanners
aggregate_scanners		Returns “scanners” aggregations
get-scanners
get_scanners		Get “scanners” by their IDs
query-scanners
query_scanners		Get “scanners IDs” by filter
update-scanners
update_scanners		Update “scanners” using provided specifications

aggregate-scanners

Section titled “aggregate-scanners”

Returns “scanners” aggregations

Method POST
Route /netscan/aggregates/scanners/GET/v1
Scope Network scanning: READ
PEP 8 aggregate_scanners

Parameters

Section titled “Parameters”
body body · dictionary
Full body payload as JSON formatted dictionary.
date_ranges body · array
exclude body · string
extended_bounds body · object
field body · string
filter body · string
filters_spec body · object
from body · integer
include body · string
interval body · string
max_doc_count body · integer
min_doc_count body · integer
missing body · string
name body · string
percents body · array
q body · string
ranges body · array
size body · integer
sort body · string
sub_aggregates body · array
time_zone body · string
type body · string
Code Examples
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)
Responses
[
  {
    "buckets": [],
    "doc_count_error_upper_bound": 0,
    "hits": {},
    "name": "string",
    "sum_other_doc_count": 0
  }
]

get-scanners

Section titled “get-scanners”

Get “scanners” by their IDs

Method GET
Route /netscan/entities/scanners/v1
Scope Network scanning: READ
PEP 8 get_scanners

Parameters

Section titled “Parameters”
ids query · string or list of strings
IDs of “scanners” to be retrieved (Min: 1, Max: 100)
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
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)
Responses
[
  {
    "agent_version": "string",
    "aid": "string",
    "available_disk_space": 0,
    "available_disk_space_pct": 0,
    "average_memory_usage": 0,
    "average_memory_usage_pct": 0,
    "average_processor_usage": 0,
    "hostname": "string",
    "id": "string",
    "last_seen_network_id": "string",
    "last_seen_timestamp": "string",
    "last_seen_zone_id": "string",
    "local_ip": "string",
    "max_memory_usage": 0,
    "max_memory_usage_pct": 0,
    "max_processor_usage": 0,
    "network_ids": [],
    "os_version": "string",
    "platform_name": "string",
    "product_type_desc": "string",
    "used_disk_space": 0,
    "used_disk_space_pct": 0
  }
]

query-scanners

Section titled “query-scanners”

Get “scanners IDs” by filter

Method GET
Route /netscan/queries/scanners/v1
Scope Network scanning: READ
PEP 8 query_scanners

Parameters

Section titled “Parameters”
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 “scanners IDs” to return in this response (Min: 1, Max: 100, Default: 100)
sort query · string
Sort “scanners” by their properties. A single sort field is allowed
filter query · string
Search for “scanners” by providing an FQL filter
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import NetworkScanScanners


falcon = NetworkScanScanners(client_id=CLIENT_ID,
                             client_secret=CLIENT_SECRET
                             )


response = falcon.query_scanners(offset=integer,
                                 limit=integer,
                                 sort="string",
                                 filter="string")
print(response)
Responses
[
  "string"
]

update-scanners

Section titled “update-scanners”

Update “scanners” using provided specifications

Method PATCH
Route /netscan/entities/scanners/v1
Scope Network scanning: WRITE
PEP 8 update_scanners

Parameters

Section titled “Parameters”
body body · dictionary
Full body payload as JSON formatted dictionary.
action body · string
The action to take on the provided set of scanners
Available values (2)
addremove
aids body · array
The AIDs of scanners to act on
Code Examples
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)
Responses
[
  "string"
]
© 2026 CrowdStrike, Inc. All rights reserved. Privacy Notice Cookie Notice Terms of Use