Quick Scan

Using the Quick Scan service collection

Table of Contents

Operation ID	Description
GetScansAggregates PEP8 get_scans_aggregates	Get scans aggregations as specified via json in request body.
GetScans PEP8 get_scans	Check the status of a volume scan. Time required for analysis increases with the number of samples in a volume but usually it should take less than 1 minute
ScanSamples PEP8 scan_samples	Submit a volume of files for ml scanning. Time required for analysis increases with the number of samples in a volume but usually it should take less than 1 minute
QuerySubmissionsMixin0 PEP8 query_submissions	Find IDs for submitted scans by providing an FQL filter and paging details. Returns a set of volume IDs that match your criteria.

GetScansAggregates

Get scans aggregations as specified via json in request body.

PEP8 method name

get_scans_aggregates

Content-Type

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

Parameters

Required	Name	Type	Datatype	Description
✅	body	body	string

Usage

Service class example (PEP8 syntax)

from falconpy.quick_scan import QuickScan

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

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.get_scans_aggregates(body=BODY)
print(response)

Service class example (Operation ID syntax)

from falconpy.quick_scan import QuickScan

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

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.GetScansAggregates(body=BODY)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

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

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.command("GetScansAggregates", body=BODY)
print(response)

GetScans

Check the status of a volume scan. Time required for analysis increases with the number of samples in a volume but usually it should take less than 1 minute

PEP8 method name

get_scans

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	array (string)	ID of a submitted scan

Usage

Service class example (PEP8 syntax)

from falconpy.quick_scan import QuickScan

falcon = QuickScan(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_scans(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy.quick_scan import QuickScan

falcon = QuickScan(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.GetScans(ids=id_list)
print(response)

Uber class example

from falconpy.api_complete 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("GetScans", ids=id_list)
print(response)

ScanSamples

Submit a volume of files for ml scanning. Time required for analysis increases with the number of samples in a volume but usually it should take less than 1 minute

PEP8 method name

scan_samples

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	body	body	string	Submit a batch of SHA256s for ml scanning. The samples must have been previously uploaded through /samples/entities/samples/v3

Usage

Service class example (PEP8 syntax)

from falconpy.quick_scan import QuickScan

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

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.scan_samples(body=BODY)
print(response)

Service class example (Operation ID syntax)

from falconpy.quick_scan import QuickScan

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

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.ScanSamples(body=BODY)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

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

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.command("ScanSamples", body=BODY)
print(response)

QuerySubmissionsMixin0

Find IDs for submitted scans by providing an FQL filter and paging details. Returns a set of volume IDs that match your criteria.

PEP8 method name

query_submissions

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
	filter	query	string	Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see our FQL documentation in Falcon.
	offset	query	string	The offset to start retrieving submissions from.
	limit	query	integer	Maximum number of volume IDs to return. Max: 5000.
	sort	query	string	Sort order: asc or desc.

Usage

Service class example (PEP8 syntax)

from falconpy.quick_scan import QuickScan

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

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

Service class example (Operation ID syntax)

from falconpy.quick_scan import QuickScan

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

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

Uber class example

from falconpy.api_complete import APIHarness

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

PARAMS = {
    "filter": "string",
    "offset": "string",
    "limit": integer,
    "sort": "string"
}

response = falcon.command("QuerySubmissionsMixin0", parameters=PARAMS)
print(response)