Skip to content

Cloud Security Assets

The Cloud Security Assets service collection provides operations for querying and retrieving cloud resource data across your environment. Find assets by application resource, retrieve compliance data by account, fetch raw resource details by ID, and query the full asset inventory using FQL filters.

LanguageLast Update
Pythonv1.5.5
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
cloud_security_assets_combined_application_findings
combined_application_findings
Get findings for an application resource with pagination.
cloud_security_assets_combined_compliance_by_account
get_combined_compliance_by_account
Get combined compliance by account.
cloud_security_assets_entities_get
get_assets
Gets raw resources based on the provided IDs param. Maximum of 100 resources can be requested with this method. Use POST method with same path if more are required.
cloud_security_assets_queries
query_assets
Query cloud security assets.

cloud_security_assets_combined_application_findings

Section titled “cloud_security_assets_combined_application_findings”

Get findings for an application resource with pagination.

GET /cloud-security-assets/combined/application-findings/v1
Scope Cloud Security Assets: READ Consumes · Produces application/json
PEP 8 combined_application_findings
NameTypeData typeDescription
crnquerystringDeprecated: Use gcrn instead. Application CRN.
gcrnquerystringApplication GCRN.
typequerystringFinding type.
filterquerystringFQL string to filter findings.
offsetqueryintegerPagination offset.
limitqueryintegerPage size. Maximum value is 1000, minimum value is 1. When not specified, 50 is used.
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import CloudSecurityAssets
falcon = CloudSecurityAssets(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.combined_application_findings(crn="string",
gcrn="string",
type="string",
filter="string",
offset=integer,
limit=integer)
print(response)

cloud_security_assets_combined_compliance_by_account

Section titled “cloud_security_assets_combined_compliance_by_account”

Gets combined compliance data aggregated by account and region. Results can be filtered and sorted.

GET /cloud-security-assets/combined/compliance-controls/by-account-region-and-resource-type/v1
Scope Cloud Security Assets: READ Consumes · Produces application/json
PEP 8 get_combined_compliance_by_account
NameTypeData typeDescription
filterquerystringFQL string to filter on asset contents. Filterable fields include: account_id, account_name, assessment_id, business_impact, cloud_group, cloud_label, cloud_label_id, cloud_provider, cloud_scope, compliant, control.benchmark.name, control.benchmark.version, control.extension.status, control.framework, control.name, control.type, control.version, environment, last_evaluated, region, resource_provider, resource_type, resource_type_name, service, service_category, severities, tag_key, tag_value, and tags_string.
sortquerystringSort expression in format: field|direction (e.g., last_evaluated|desc). Allowed sort fields: account_id, account_name, assessment_id, cloud_provider, control.benchmark.name, control.benchmark.version, control.framework, control.name, control.type, control.version, last_evaluated, region, resource_counts.compliant, resource_counts.non_compliant, resource_counts.total, resource_provider, resource_type, resource_type_name, service, and service_category.
limitqueryintegerThe maximum number of items to return. When not specified or 0, 20 is used. When larger than 10000, 10000 is used.
offsetqueryintegerOffset returned controls. Use only one of ‘offset’ and ‘after’ parameter for paginating. ‘offset’ can only be used on offsets < 10,000. For paginating through the entire result set, use ‘after’ parameter
afterquerystringtoken-based pagination. use for paginating through an entire result set. Use only one of ‘offset’ and ‘after’ parameters for paginating
include_failing_iom_severity_countsquerybooleanInclude counts of failing IOMs by severity level
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import CloudSecurityAssets
falcon = CloudSecurityAssets(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_combined_compliance_by_account(filter="string",
sort="string",
limit=integer,
offset=integer,
after="string",
include_failing_iom_severity_counts=boolean)
print(response)

Gets raw resources based on the provided IDs param. Maximum of 100 resources can be requested with this method.

GET /cloud-security-assets/entities/resources/v1
Scope Cloud Security Assets: READ Consumes · Produces application/json
PEP 8 get_assets
NameTypeData typeDescription
idsquerystring or list of stringsList of assets to return (maximum 100 IDs allowed).
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import CloudSecurityAssets
falcon = CloudSecurityAssets(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_assets(ids=id_list)
print(response)

Gets a list of resource IDs for the given parameters, filters and sort criteria.

GET /cloud-security-assets/queries/resources/v1
Scope Cloud Security Assets: READ Consumes · Produces application/json
PEP 8 query_assets
NameTypeData typeDescription
afterquerystringtoken-based pagination. use for paginating through an entire result set. Use only one of ‘offset’ and ‘after’ parameters for paginating
filterquerystringFQL string to filter on asset contents. Filterable fields include: account_id, account_name, active, aspm.deployment_cloud_resource_id, aspm.deployment_provider, aspm.deployment_type, aspm.technologies, azure.vm_id, business_impact, cloud_group, cloud_label, cloud_label_id, cloud_provider, cloud_risks.rule, cloud_risks.severity, cloud_risks.status, cloud_scope, cluster_id, cluster_name, compartment_ocid, compliant.benchmark_name, compliant.benchmark_version, compliant.framework, compliant.policy_id, compliant.requirement, compliant.rule, compliant.section, configuration.id, control.benchmark.name, control.benchmark.version, control.framework, control.requirement, control.type, control.version, creation_time, cve_ids, data_classifications.found, data_classifications.label, data_classifications.label_id, data_classifications.scanned, data_classifications.tag, data_classifications.tag_id, environment, exprt_ratings, first_seen, highest_severity, id, insights.boolean_value, insights.date_value, insights.id, insights.integer_value, insights.string_list_value, insights.string_value, instance_id, instance_state, ioa_count, iom_count, legacy_resource_id, legacy_uuid, managed_by, non_compliant.benchmark_name, non_compliant.benchmark_version, non_compliant.framework, non_compliant.policy_id, non_compliant.requirement, non_compliant.rule, non_compliant.rule_name, non_compliant.section, non_compliant.severity, organization_Id, os_version, platform_name, publicly_exposed, region, resource_id, resource_name, resource_parent, resource_type, resource_type_name, sensor_priority, service, service_category, severity, snapshot_detections, ssm_managed, status, tag_key, tag_value, tags, tags_string, tenant_id, updated_at, vmware.guest_os_id, vmware.guest_os_version, vmware.host_system_name, vmware.host_type, vmware.instance_uuid, vmware.vm_host_name, vmware.vm_tools_status, and zone
sortquerystringThe field to sort on. Sortable fields include: account_id, account_name, active, aspm.deployment_cloud_resource_id, aspm.deployment_provider, aspm.deployment_type, aspm.technologies, cloud_provider, cloud_risks.open_risk_count, cluster_id, cluster_name, compartment_name, compartment_ocid, compartment_path, creation_time, data_classifications.found, data_classifications.scanned, first_seen, id, instance_id, instance_state, ioa_count, iom_count, managed_by, organization_Id, os_version, platform_name, publicly_exposed, publiclyExposedAccessRange, publiclyExposedExposureMethod, publiclyExposedToTheInternet, region, resource_id, resource_name, resource_parent, resource_type, resource_type_name, service, service_category, ssm_managed, status, tenancy_name, tenancy_ocid, tenancy_type, tenant_id, updated_at, vmware.guest_os_id, vmware.guest_os_version, vmware.host_system_name, vmware.host_type, vmware.instance_uuid, vmware.vm_host_name, vmware.vm_tools_status, and zone.
limitqueryintegerThe maximum number of items to return. When not specified or 0, 500 is used. When larger than 1000, 1000 is used.
offsetqueryintegerOffset returned assets. Use only one of ‘offset’ and ‘after’ parameter for paginating. ‘offset’ can only be used on offsets < 10,000. For paginating through the entire result set, use ‘after’ parameter
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import CloudSecurityAssets
falcon = CloudSecurityAssets(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_assets(after="string",
filter="string",
sort="string",
limit=integer,
offset=integer)
print(response)