Skip to content

Container Packages

The Container Packages service collection provides operations for querying container software packages and their vulnerability data. Retrieve packages by image count, vulnerability count, zero-day impact, and export package data for analysis.

LanguageLast Update
Pythonv1.4.8
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
ReadPackagesByImageCount
read_packages_by_image_count
Retrieves the N most frequently used packages across images.
ReadPackagesCountByZeroDay
read_zero_day_counts
Retrieve packages count affected by zero day vulnerabilities.
ReadPackagesByFixableVulnCount
read_fixable_vuln_count
Retrieve top x app packages with the most fixable vulnerabilities.
ReadPackagesByVulnCount
read_vuln_count
Retrieve top x packages with the most vulnerabilities.
ReadPackagesCombinedExport
read_combined_export
Retrieve packages identified by the provided filter criteria for the purpose of export.
ReadPackagesCombined
read_combined
Retrieve packages identified by the provided filter criteria.
ReadPackagesCombinedV2
read_packages
Retrieve packages identified by the provided filter criteria.

Retrieves the N most frequently used packages across images.

GET /container-security/aggregates/packages/by-image-count/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_packages_by_image_count
NameTypeData typeDescription
filterquerystringFilter packages using a query in Falcon Query Language (FQL). Supported filter fields: ai_related, cveid, running_images, severity, type, and vulnerability_count.
limitqueryintegerMaximum number of package results to return. Default value: 5.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required if using other keywords.
from falconpy import ContainerPackages
falcon = ContainerPackages(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_packages_by_image_count(filter="string", limit=integer)
print(response)

Retrieve packages count affected by zero day vulnerabilities.

GET /container-security/aggregates/packages/count-by-zero-day/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_zero_day_counts
NameTypeData typeDescription
filterquerystringFilter packages using a query in Falcon Query Language (FQL). Supported filters: cid.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required if using other keywords.
from falconpy import ContainerPackages
falcon = ContainerPackages(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_zero_day_counts(filter="string")
print(response)

Retrieve top x app packages with the most fixable vulnerabilities.

GET /container-security/combined/packages/app-by-fixable-vulnerability-count/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_fixable_vuln_count
NameTypeData typeDescription
filterquerystringFilter packages using a query in Falcon Query Language (FQL). Supported filters: cid, container_id, cveid, fix_status, image_digest, license, package_name_version, severity, type, vulnerability_count.
limitqueryintegerThe upper-bound on the number of records to retrieve.
offsetqueryintegerThe offset from where to begin.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required if using other keywords.
from falconpy import ContainerPackages
falcon = ContainerPackages(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_fixable_vuln_count(filter="string",
limit=integer,
offset=integer)
print(response)

Retrieve top x packages with the most vulnerabilities.

GET /container-security/combined/packages/by-vulnerability-count/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_vuln_count
NameTypeData typeDescription
filterquerystringFilter packages using a query in Falcon Query Language (FQL). Supported filters: cid, container_id, cveid, fix_status, image_digest, license, package_name_version, severity, type, vulnerability_count.
limitqueryintegerThe upper-bound on the number of records to retrieve.
offsetqueryintegerThe offset from where to begin.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required if using other keywords.
from falconpy import ContainerPackages
falcon = ContainerPackages(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_vuln_count(filter="string",
limit=integer,
offset=integer)
print(response)

Retrieve packages identified by the provided filter criteria for the purpose of export.

GET /container-security/combined/packages/export/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_combined_export
NameTypeData typeDescription
filterquerystringFilter packages using a query in Falcon Query Language (FQL). Supported filters: cid, container_id, cveid, fix_status, image_digest, license, package_name_version, severity, type, vulnerability_count.
only_zero_day_affectedqueryboolean(true/false) load zero day affected packages, default is false.
limitqueryintegerThe upper-bound on the number of records to retrieve.
offsetqueryintegerThe offset from where to begin.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required if using other keywords.
sortquerystringThe fields to sort the records on. Supported columns: license, package_name_version, type.
from falconpy import ContainerPackages
falcon = ContainerPackages(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_combined_export(filter="string",
only_zero_day_affected=boolean,
limit=integer,
offset=integer,
sort="string")
print(response)

Retrieve packages identified by the provided filter criteria.

GET /container-security/combined/packages/v1
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_combined
NameTypeData typeDescription
filterquerystringFilter packages using a query in Falcon Query Language (FQL). Supported filters: ai_related, cid, container_id, cveid, fix_status, image_digest, license, package_name_version, severity, type, and vulnerability_count.
only_zero_day_affectedquerybooleanLoad zero day affected packages. Default: false.
limitqueryintegerThe upper-bound on the number of records to retrieve.
offsetqueryintegerThe offset from where to begin.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required if using other keywords.
sortquerystringThe fields to sort the records on. Supported columns: license, package_name_version, and type.
from falconpy import ContainerPackages
falcon = ContainerPackages(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_combined(filter="string",
only_zero_day_affected=boolean,
limit=integer,
offset=integer,
sort="string")
print(response)

Retrieve packages identified by the provided filter criteria.

GET /container-security/combined/packages/v2
Scope Falcon Container Image: READ Consumes · Produces application/json
PEP 8 read_packages
NameTypeData typeDescription
filterquerystringFilter packages using a query in Falcon Query Language (FQL). Supported filters: ai_related, cid, container_id, cveid, fix_status, image_digest, license, package_name_version, severity, type, and vulnerability_count.
only_zero_day_affectedquerybooleanLoad zero day affected packages. Default: false.
limitqueryintegerThe upper-bound on the number of records to retrieve.
offsetqueryintegerThe offset from where to begin.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required if using other keywords.
sortquerystringThe fields to sort the records on. Supported columns: license, package_name_version, and type.
from falconpy import ContainerPackages
falcon = ContainerPackages(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_packages(filter="string",
only_zero_day_affected=boolean,
limit=integer,
offset=integer,
sort="string")
print(response)