Sensor Download

Using the Sensor Download service collection

Table of Contents

Operation ID	Description
GetCombinedSensorInstallersByQuery PEP 8 get_combined_sensor_installers_by_query	Get sensor installer details by provided query
DownloadSensorInstallerById PEP 8 download_sensor_installer	Download sensor installer by SHA256 ID
GetSensorInstallersEntities PEP 8 get_sensor_installer_entities	Get sensor installer details by provided SHA256 IDs
GetSensorInstallersCCIDByQuery PEP 8 get_sensor_installer_ccid	Get CCID to use with sensor installers
GetSensorInstallersByQuery PEP 8 get_sensor_installers_by_query	Get sensor installer IDs by provided query

GetCombinedSensorInstallersByQuery

Get sensor installer details by provided query

PEP8 method name

get_combined_sensor_installers_by_query

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
limit			query	integer	The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results.
filter			query	string	Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: platform:"windows" version:>"5.2"
offset			query	integer	The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.
parameters			query	string	Full query string parameters payload in JSON format.
sort			query	string	Sort items using their properties. Common sort options include: version|asc release_date|desc

Usage

Service class example (PEP8 syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.get_combined_sensor_installers_by_query(offset=integer,
                                                          limit=integer,
                                                          sort="string",
                                                          filter="string"
                                                          )
print(response)

Service class example (Operation ID syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.GetCombinedSensorInstallersByQuery(offset=integer,
                                                     limit=integer,
                                                     sort="string",
                                                     filter="string"
                                                     )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("GetCombinedSensorInstallersByQuery",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="string"
                          )
print(response)

DownloadSensorInstallerById

Download sensor installer by SHA256 ID

PEP8 method name

download_sensor_installer

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
download_path			query	string	File path to use for the saved file. Must be present to trigger a file download.
id			query	string	SHA256 of the installer to download
file_name			query	string	File name to use for the saved file. Must be present to trigger a file download.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.download_sensor_installer(id="string",
                                            download_path="/tmp/",
                                            file_name="cs_installer.bin"
                                            )
print(response)

Service class example (Operation ID syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.DownloadSensorInstallerById(id="string",
                                              download_path="/tmp/",
                                              file_name="cs_installer.exe"
                                              )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("DownloadSensorInstallerById", id="string")
print(response)

GetSensorInstallersEntities

Get sensor installer details by provided SHA256 IDs

PEP8 method name

get_sensor_installer_entities

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
ids			query	string or list of strings	The IDs of the installers to retrieve details for.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_sensor_installer_entities(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.GetSensorInstallersEntities(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("GetSensorInstallersEntities", ids=id_list)
print(response)

GetSensorInstallersCCIDByQuery

Get CCID to use with sensor installers

PEP8 method name

get_sensor_installer_ccid

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.get_sensor_installer_ccid()
print(response)

Service class example (Operation ID syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.GetSensorInstallersCCIDByQuery()
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("GetSensorInstallersCCIDByQuery")
print(response)

GetSensorInstallersByQuery

Get sensor installer IDs by provided query

PEP8 method name

get_sensor_installers_by_query

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
filter			query	string	Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: platform:"windows" version:>"5.2"
limit			query	integer	The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results.
offset			query	integer	The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.
parameters			query	string	Full query string parameters payload in JSON format.
sort			query	string	Sort items using their properties. Common sort options include: version|asc release_date|desc

Usage

Service class example (PEP8 syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.get_sensor_installers_by_query(offset=integer,
                                                 limit=integer,
                                                 sort="string",
                                                 filter="string"
                                                 )
print(response)

Service class example (Operation ID syntax)

from falconpy import SensorDownload

falcon = SensorDownload(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.GetSensorInstallersByQuery(offset=integer,
                                             limit=integer,
                                             sort="string",
                                             filter="string"
                                             )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("GetSensorInstallersByQuery",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="string"
                          )
print(response)