> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-commands-guide/coverage-commands.md).

# Coverage Commands

* [getAssetCoverage](#getassetcoverage)
* [getAssetCoverageHistogram](#getassetcoveragehistogram)

#### getAssetCoverage

***

Returns a list of assets with their scan coverage status based on the provided filter criteria.

<details>

<summary>Arguments</summary>

| Argument Name                    | Description                                                                                                                                                                                                                                                                                                                                                              | Required |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| 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 |

</details>

<details>

<summary>Outputs</summary>

**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.

</details>

#### getAssetCoverageHistogram

***

Returns the distribution of values (counts and percentages) for the specified asset-coverage fields based on the provided filter criteria.

<details>

<summary>Arguments</summary>

| Argument Name                    | Description                                                                                                                                                                                                                                                                                                                                                                              | Required |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| 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 |

</details>

<details>

<summary>Outputs</summary>

**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.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/cortex-commands-guide/coverage-commands.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
