Skip to content

Serverless Exports

The Serverless Exports service collection provides operations for managing export jobs for Lambda Security resources. Read export job entities, query available jobs, download export files, retrieve vulnerabilities in SARIF format, and launch new export jobs.

LanguageLast Update
Pythonv1.5.5
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
ReadExportJobsMixin0
read_export_jobs
Read export jobs entities.
QueryExportJobsMixin0
query_export_jobs
Query export jobs entities.
DownloadExportFileMixin0
download_export_file
Download an export file.
LaunchExportJobMixin0
launch_export_job
Launch an export job of a Lambda Security resource.

Read export jobs entities.

GET /lambdas/entities/exports/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_export_jobs
NameTypeData typeDescription
idsquerystring or list of stringsExport Job IDs to read. Allowed up to 100 IDs per request.
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import ServerlessExports
falcon = ServerlessExports(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.read_export_jobs(ids=id_list)
print(response)

Query export jobs entities.

GET /lambdas/queries/exports/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 query_export_jobs
NameTypeData typeDescription
filterquerystringFilter exports using a query in Falcon Query Language (FQL). Only the last 100 jobs are returned. Supported filter fields: resource, status.
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import ServerlessExports
falcon = ServerlessExports(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_export_jobs(filter="string")
print(response)

Download an export file.

GET /lambdas/entities/exports/files/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 download_export_file
NameTypeData typeDescription
idquerystringExport job ID.
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import ServerlessExports
falcon = ServerlessExports(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("output_file", "wb") as save_file:
response = falcon.download_export_file(id="string", stream=boolean)
save_file.write(response)

Launch an export job of a Lambda Security resource. Maximum of 1 job in progress per resource. Use expand_vulnerabilities=true to get detailed vulnerability information.

POST /lambdas/entities/exports/v1
Scope Falcon Container Image: WRITE Consumes · Produces application/json
PEP 8 launch_export_job
NameTypeData typeDescription
expand_vulnerabilitiesbodybooleanFlag to include detailed vulnerability information.
formatbodystringThe export file format.
fqlbodystringFilter the export using Falcon Query Language (FQL).
resourcebodystringThe resource to export. Supported resources: function.detections, function.vulnerabilities-expanded, function.vulnerabilities.
sortbodystringThe fields to sort the records on.
bodybodydictionaryFull body payload as a JSON formatted dictionary.
from falconpy import ServerlessExports
falcon = ServerlessExports(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.launch_export_job(expand_vulnerabilities=boolean,
format="string",
fql="string",
resource="string",
sort="string")
print(response)