Coverage Commands
getAssetCoverage
Returns a list of assets with their scan coverage status based on the provided filter criteria.
Arguments
asset_ids
A comma-separated list of asset IDs to filter by.
Optional
asset_names
A comma-separated list of asset names to filter by.
Optional
business_application_names
A comma-separated list of business application names to filter by.
Optional
status_coverages
A comma-separated list of coverage statuses to filter by. Possible values are: FULLY SCANNED, NOT SCANNED, PARTIALLY SCANNED.
Optional
is_scanned_by_vulnerabilities
A comma-separated list of vulnerability-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_code_weakness
A comma-separated list of code-weakness-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_secrets
A comma-separated list of secrets-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_iac
A comma-separated list of IaC-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_malware
A comma-separated list of malware-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_cicd
A comma-separated list of CI/CD-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
last_scan_statuses
A comma-separated list of last-scan statuses to filter by. Possible values are: NOT_SCANNED_YET, ERROR, COMPLETED.
Optional
asset_types
A comma-separated list of asset types to filter by. Possible values are: CICD PIPELINE, CONTAINER IMAGE REPOSITORY, REPOSITORY.
Optional
asset_providers
A comma-separated list of asset providers to filter by. Possible values are: AWS, AWS_CODE_BUILD, AWS_CODE_COMMIT, AZURE, AZURE_PIPELINES, AZURE_REPOS, BITBUCKET, CIRCLE_CI, DOCKER, GCP, GITHUB, GITHUB_ACTIONS, GITLAB, GITLAB_CI, HCP_TFC_RUN_TASKS, JENKINS, JFROG_ARTIFACTORY, OCI.
Optional
vendor_names
A comma-separated list of vendor names to filter by. Possible values are: AWS, AWS_CODE_BUILD, AWS_CODE_COMMIT, AZURE, AZURE_REPOS, BITBUCKET, BITBUCKET_DATACENTER, CIRCLE_CI, DOCKER, GCP, GITHUB, GITHUB_ACTIONS, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, HCP_TFC_RUN_TASKS, HCP_TFE_RUN_TASKS, JENKINS, JFROG_ARTIFACTORY, OCI.
Optional
limit
The maximum number of assets to return. Ignored when 'page' or 'page_size' is provided. Default is 50.
Optional
page_size
The number of assets to return per page. When provided, manual pagination is used and 'limit' is ignored.
Optional
page
The page number to return (0-based). When provided, manual pagination is used and 'limit' is ignored.
Optional
sort_field
The field by which to sort the results. Possible values are: asset_id, asset_name, business_application_names, status_coverage, is_scanned_by_vulnerabilities, is_scanned_by_code_weakness, is_scanned_by_secrets, is_scanned_by_iac, is_scanned_by_malware, is_scanned_by_cicd, last_scan_status, asset_type, asset_provider, vendor_name.
Optional
sort_order
The order in which to sort the results. Possible values are: DESC, ASC.
Optional
Outputs
Core.Coverage.Asset.AssetID string
The unique ID of the asset. Each asset is assigned a unique identifier in the system.
Core.Coverage.Asset.AssetName string
The name of the asset. Typically corresponds to the repository, container image, or pipeline name.
Core.Coverage.Asset.AssetProvider string
The vendor or source platform of the asset.
Core.Coverage.Asset.AssetType string
The type or category of the asset.
Core.Coverage.Asset.BusinessApplicationNames string
A list of business applications associated with the asset.
Core.Coverage.Asset.IsScannedByCICD string
Indicates whether the asset is scanned within CI/CD pipelines.
Core.Coverage.Asset.IsScannedByCodeWeakness string
Indicates whether code weakness scanning is performed on the asset.
Core.Coverage.Asset.IsScannedByIaC string
Indicates whether infrastructure-as-code (IaC) scanning is enabled for the asset.
Core.Coverage.Asset.IsScannedByMalware string
Indicates whether malware scanning is enabled for the asset.
Core.Coverage.Asset.IsScannedBySecrets string
Indicates whether the asset is scanned for hardcoded secrets or credentials.
Core.Coverage.Asset.IsScannedBySemgrep boolean
Indicates whether the asset is analyzed using Semgrep.
Core.Coverage.Asset.IsScannedBySonarqube boolean
Indicates whether the asset is analyzed using SonarQube.
Core.Coverage.Asset.IsScannedByVeracode boolean
Indicates whether the asset is scanned using Veracode.
Core.Coverage.Asset.IsScannedByVulnerabilities string
Indicates whether vulnerability scanning is enabled for the asset.
Core.Coverage.Asset.LastScanStatus string
The status of the most recent scan performed on the asset.
Core.Coverage.Asset.ScannersData unknown
Detailed information from the scanners that evaluated the asset.
Core.Coverage.Asset.StatusCoverage string
The overall scan coverage of the asset.
Core.Coverage.Asset.UnifiedProvider string
The unified provider name associated with the asset.
getAssetCoverageHistogram
Returns the distribution of values (counts and percentages) for the specified asset-coverage fields based on the provided filter criteria.
Arguments
asset_ids
A comma-separated list of asset IDs to filter by.
Optional
asset_names
A comma-separated list of asset names to filter by.
Optional
business_application_names
A comma-separated list of business application names to filter by.
Optional
status_coverages
A comma-separated list of coverage statuses to filter by. Possible values are: FULLY SCANNED, NOT SCANNED, PARTIALLY SCANNED.
Optional
is_scanned_by_vulnerabilities
A comma-separated list of vulnerability-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_code_weakness
A comma-separated list of code-weakness-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_secrets
A comma-separated list of secrets-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_iac
A comma-separated list of IaC-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_malware
A comma-separated list of malware-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
is_scanned_by_cicd
A comma-separated list of CI/CD-scan states to filter by. Possible values are: DISABLED, ENABLED, IRRELEVANT.
Optional
last_scan_statuses
A comma-separated list of last-scan statuses to filter by. Possible values are: NOT_SCANNED_YET, ERROR, COMPLETED.
Optional
asset_types
A comma-separated list of asset types to filter by. Possible values are: CICD PIPELINE, CONTAINER IMAGE REPOSITORY, REPOSITORY.
Optional
asset_providers
A comma-separated list of asset providers to filter by. Possible values are: AWS, AWS_CODE_BUILD, AWS_CODE_COMMIT, AZURE, AZURE_PIPELINES, AZURE_REPOS, BITBUCKET, CIRCLE_CI, DOCKER, GCP, GITHUB, GITHUB_ACTIONS, GITLAB, GITLAB_CI, HCP_TFC_RUN_TASKS, JENKINS, JFROG_ARTIFACTORY, OCI.
Optional
vendor_names
A comma-separated list of vendor names to filter by. Possible values are: AWS, AWS_CODE_BUILD, AWS_CODE_COMMIT, AZURE, AZURE_REPOS, BITBUCKET, BITBUCKET_DATACENTER, CIRCLE_CI, DOCKER, GCP, GITHUB, GITHUB_ACTIONS, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, HCP_TFC_RUN_TASKS, HCP_TFE_RUN_TASKS, JENKINS, JFROG_ARTIFACTORY, OCI.
Optional
columns
A comma-separated list of fields for which to generate histograms. Possible values are: asset_name, business_application_names, status_coverage, is_scanned_by_vulnerabilities, is_scanned_by_code_weakness, is_scanned_by_secrets, is_scanned_by_iac, is_scanned_by_malware, is_scanned_by_cicd, last_scan_status, asset_type, asset_provider, vendor_name.
Required
max_values_per_column
The maximum number of distinct values to return for each column. Default is 100.
Optional
Outputs
Core.Coverage.Histogram.ColumnName string
The column over which the histogram is generated.
Core.Coverage.Histogram.Data.Value string
The distinct value.
Core.Coverage.Histogram.Data.Count number
The number of records with this value after filtering.
Core.Coverage.Histogram.Data.Percentage number
The percentage of filtered records with this value.
Core.Coverage.Histogram.Data.PrettyName string
A user-friendly label for the value.
Last updated
Was this helpful?