> 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-cloud-api/aspm-cicd-and-application-security/scan-management.md).

# Scan Management

APIs for managing scans

## Get unscanned AppSec scan management repositories

> Get a list of Application Security repositories that have not been scanned. You can optionally filter by specifying the number of days past during which the repositories were not scanned.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"Scan management","description":"APIs for managing scans"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/scans/unscanned-repositories":{"get":{"tags":["Scan management"],"summary":"Get unscanned AppSec scan management repositories","description":"Get a list of Application Security repositories that have not been scanned. You can optionally filter by specifying the number of days past during which the repositories were not scanned.\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.","operationId":"GetUnscannedRepos","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"name":"days","in":"query","description":"Define the time period in days previous to now","required":false,"schema":{"type":"number","format":"double","default":7}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BasicScanInfo"}}}}}}}}},"components":{"schemas":{"BasicScanInfo":{"type":"object","properties":{"organizationId":{"type":"string","description":"Organization ID"},"repoName":{"type":"string","description":"Name of the repository"},"repoId":{"type":"string","description":"ID of the repository"}}}}}}
```

## Get AppSec branch periodic scans

> Branch periodic scans are automated checks that assess the security posture of applications and infrastructure. \
> \
> Get the details of branch periodic scans.\
> \
> \*\*How to access branch periodic scans in the UI:\*\* Under \*\*Modules\*\* select \*\*Application Security\*\* > \*\*Branch Periodic Scanning\*\* (under \*\*Scans\*\*).\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"Scan management","description":"APIs for managing scans"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/scans/periodic":{"get":{"operationId":"GetPeriodicScans","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PeriodicScansResponse"},"type":"array"}}}}},"tags":["Scan management"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"in":"query","name":"organizationName","required":false,"schema":{"type":"string"}},{"in":"query","name":"repositories","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"branchName","required":false,"schema":{"type":"string"}},{"in":"query","name":"scanHealth","required":false,"schema":{"$ref":"#/components/schemas/ScanHealthEnum"}},{"in":"query","name":"days","required":false,"schema":{"default":7,"format":"double","type":"number"}},{"in":"query","name":"offset","required":false,"schema":{"format":"double","type":"number","default":0}},{"in":"query","name":"limit","required":false,"schema":{"format":"double","type":"number","default":100}}],"summary":"Get AppSec branch periodic scans","description":"Branch periodic scans are automated checks that assess the security posture of applications and infrastructure. \n\nGet the details of branch periodic scans.\n\n**How to access branch periodic scans in the UI:** Under **Modules** select **Application Security** > **Branch Periodic Scanning** (under **Scans**).\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on."}}},"components":{"schemas":{"PeriodicScansResponse":{"type":"object","properties":{"issuesFound":{"$ref":"#/components/schemas/Record_string.number_"},"findingsSeverityBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"findingsTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"issuesTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"repositoryId":{"type":"string","description":"ID of the scanned repository"},"integrationId":{"type":"string"},"provider":{"type":"string"},"scanId":{"type":"string","description":"Scan ID"},"scanHealth":{"$ref":"#/components/schemas/ScanHealthEnum"},"scanDate":{"type":"string","description":"Timestamp of the last scan execution"},"branchName":{"type":"string","description":"The branch analyzed during the scan"},"organizationName":{"type":"string","description":"The organization owning the repository"},"repoName":{"type":"string","description":"Name of the scanned repository"}}},"Record_string.number_":{"properties":{},"additionalProperties":{"type":"number","format":"double"},"type":"object"},"ScanHealthEnum":{"enum":["COMPLETED","ERROR","PARTIALLY_COMPLETED","IN_PROGRESS"],"type":"string","description":"The health of the scan. Valid values include:\n- `ERROR`: Indicates an error with the scan\n- `PARTIALLY_COMPLETED`: Indicates that the scan executed partially with some scan modules succeeded and others failing\n- `IN_PROGRESS`: The scan is in progress\n- `COMPLETED`: Indicates that the scan is complete"}}}}
```

## Get AppSec Pull Request scans

> Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. These scans are run on default or non-default branches containing open PRs or Merge Requests (MR) from your integrated repositories.\
> \
> Get the details of PR scans.\
> \
> \*\*How to access Pull Request scans in the UI:\*\* Under \*\*Modules\*\* select \*\*Application Security\*\* \*\*Pull Request Scans\*\* (under \*\*Scans\*\*).\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"Scan management","description":"APIs for managing scans"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/scans/pr":{"get":{"operationId":"GetPRScans","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PRScansResponse"},"type":"array"}}}}},"tags":["Scan management"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"in":"query","name":"organizationName","required":false,"schema":{"type":"string"}},{"in":"query","name":"repositories","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"branchName","required":false,"schema":{"type":"string"}},{"in":"query","name":"prId","required":false,"schema":{"type":"string"}},{"in":"query","name":"prTitle","required":false,"schema":{"type":"string"}},{"in":"query","name":"prStatus","required":false,"schema":{"$ref":"#/components/schemas/ScanStatus"}},{"in":"query","name":"scanHealth","required":false,"schema":{"$ref":"#/components/schemas/ScanHealthEnum"}},{"in":"query","name":"days","required":false,"schema":{"default":7,"format":"double","type":"number"}},{"in":"query","name":"offset","required":false,"schema":{"format":"double","type":"number","default":0}},{"in":"query","name":"limit","required":false,"schema":{"format":"double","type":"number","default":100}}],"summary":"Get AppSec Pull Request scans","description":"Pull Request (PR) scans are initiated by events triggered by version control systems such as GitHub, GitLab, Bitbucket and Azure Repos, or via webhooks. These scans are run on default or non-default branches containing open PRs or Merge Requests (MR) from your integrated repositories.\n\nGet the details of PR scans.\n\n**How to access Pull Request scans in the UI:** Under **Modules** select **Application Security** **Pull Request Scans** (under **Scans**).\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on."}}},"components":{"schemas":{"PRScansResponse":{"type":"object","properties":{"issuesFound":{"$ref":"#/components/schemas/Record_string.number_"},"findingsSeverityBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"findingsTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"issuesTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"pullRequestTitle":{"type":"string"},"integrationId":{"type":"string"},"repositoryId":{"type":"string","description":"ID of the scanned repository"},"scanId":{"type":"string"},"provider":{"type":"string"},"userEmail":{"type":"string"},"blockingPolicyName":{"type":"string"},"blockingPolicyId":{"type":"string"},"scanHealth":{"$ref":"#/components/schemas/ScanHealthEnum"},"scanDate":{"type":"string","description":"The timestamp of the last scan execution"},"commitId":{"type":"string","description":"The commit included in the PR"},"pullRequestStatus":{"$ref":"#/components/schemas/ScanStatus"},"pullRequestId":{"type":"string","description":"The ID of the PR"},"branchName":{"type":"string","description":"Name of the branch analyzed during the scan"},"organizationName":{"type":"string","description":"Specifies the organization owning the repository"},"repoName":{"type":"string"}}},"Record_string.number_":{"properties":{},"additionalProperties":{"type":"number","format":"double"},"type":"object"},"ScanHealthEnum":{"enum":["COMPLETED","ERROR","PARTIALLY_COMPLETED","IN_PROGRESS"],"type":"string","description":"The health of the scan. Valid values include:\n- `ERROR`: Indicates an error with the scan\n- `PARTIALLY_COMPLETED`: Indicates that the scan executed partially with some scan modules succeeded and others failing\n- `IN_PROGRESS`: The scan is in progress\n- `COMPLETED`: Indicates that the scan is complete"},"ScanStatus":{"enum":["ERROR","FAILED","IN_PROGRESS","PASSED","PASSED_WITH_ISSUES"],"type":"string","description":"Status of the PR scan. Valid values include:\n- `PASSED`\n- `PASSED_WITH_ISSUES`\n- `BLOCKED`\n- `IN_PROGRESS`\n- `ERROR`\n- `FAILED`"}}}}
```

## Get AppSec CI scans

> CI scans detect exposed secrets, misconfigurations in your infrastructure-as-code (IaC) files, vulnerabilities in your software composition analysis (SCA) packages, and license non-compliance in your CI pipelines.\
> \
> Get the details of CI scans.\
> \
> \*\*How to access CI scans in the UI:\*\* Under \*\*Modules\*\* select \*\*Application Security\*\* > \*\*CI Scans\*\* (under \*\*Scans\*\*).\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"Scan management","description":"APIs for managing scans"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/scans/ci":{"get":{"operationId":"GetCIScans","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CIScansResponse"},"type":"array"}}}}},"tags":["Scan management"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"in":"query","name":"organizationName","required":false,"schema":{"type":"string"}},{"in":"query","name":"repositories","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"ciStatus","required":false,"schema":{"$ref":"#/components/schemas/ScanStatus"}},{"in":"query","name":"scanHealth","required":false,"schema":{"$ref":"#/components/schemas/ScanHealthEnum"}},{"in":"query","name":"days","required":false,"schema":{"default":7,"format":"double","type":"number"}},{"in":"query","name":"offset","required":false,"schema":{"format":"double","type":"number","default":0}},{"in":"query","name":"limit","required":false,"schema":{"format":"double","type":"number","default":100}}],"summary":"Get AppSec CI scans","description":"CI scans detect exposed secrets, misconfigurations in your infrastructure-as-code (IaC) files, vulnerabilities in your software composition analysis (SCA) packages, and license non-compliance in your CI pipelines.\n\nGet the details of CI scans.\n\n**How to access CI scans in the UI:** Under **Modules** select **Application Security** > **CI Scans** (under **Scans**).\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on."}}},"components":{"schemas":{"CIScansResponse":{"type":"object","properties":{"issuesFound":{"$ref":"#/components/schemas/Record_string.number_"},"findingsSeverityBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"findingsTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"issuesTypesBreakdown":{"$ref":"#/components/schemas/Record_string.number_"},"repositoryId":{"type":"string","description":"ID of the scanned repository"},"integrationId":{"type":"string"},"scanId":{"type":"string"},"provider":{"type":"string"},"blockingPolicyName":{"type":"string"},"blockingPolicyId":{"type":"string"},"ciStatus":{"$ref":"#/components/schemas/ScanStatus"},"scanHealth":{"$ref":"#/components/schemas/ScanHealthEnum"},"scanDate":{"type":"string","description":"The timestamp of the last scan execution"},"branchName":{"type":"string","description":"The name of the branch analyzed during the scan"},"organizationName":{"type":"string","description":"Name of the organization owning the repository"},"repoName":{"type":"string","description":"Name of the scanned repository"}}},"Record_string.number_":{"properties":{},"additionalProperties":{"type":"number","format":"double"},"type":"object"},"ScanStatus":{"enum":["ERROR","FAILED","IN_PROGRESS","PASSED","PASSED_WITH_ISSUES"],"type":"string","description":"Status of the PR scan. Valid values include:\n- `PASSED`\n- `PASSED_WITH_ISSUES`\n- `BLOCKED`\n- `IN_PROGRESS`\n- `ERROR`\n- `FAILED`"},"ScanHealthEnum":{"enum":["COMPLETED","ERROR","PARTIALLY_COMPLETED","IN_PROGRESS"],"type":"string","description":"The health of the scan. Valid values include:\n- `ERROR`: Indicates an error with the scan\n- `PARTIALLY_COMPLETED`: Indicates that the scan executed partially with some scan modules succeeded and others failing\n- `IN_PROGRESS`: The scan is in progress\n- `COMPLETED`: Indicates that the scan is complete"}}}}
```

## List AppSec scan issues

> Get a list of the issues discovered in the scan specified by scan ID.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"Scan management","description":"APIs for managing scans"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/scans/{scanId}/issues":{"get":{"operationId":"GetScanIssues","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ScanIssuesResponse"},"type":"array"}}}}},"tags":["Scan management"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"in":"path","name":"scanId","required":true,"schema":{"type":"string"}},{"in":"query","name":"severity","required":false,"schema":{"$ref":"#/components/schemas/SeverityEnum"}},{"in":"query","name":"offset","required":false,"schema":{"format":"double","type":"number","default":0}},{"in":"query","name":"limit","required":false,"schema":{"format":"double","type":"number","default":100}}],"summary":"List AppSec scan issues","description":"Get a list of the issues discovered in the scan specified by scan ID.\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on."}}},"components":{"schemas":{"ScanIssuesResponse":{"properties":{"resolution_comment":{"type":"string"},"resolution_reason":{"$ref":"#/components/schemas/ResolutionReason"},"resolution_status":{"$ref":"#/components/schemas/ResolutionStatus"},"assignee":{"type":"string"},"branch":{"type":"string"},"run_id":{"type":"string"},"pull_request_id":{"type":"string"},"repo_id":{"type":"string"},"created":{"type":"string"},"file_path":{"type":"string"},"asset_name":{"type":"string"},"detection_method":{"$ref":"#/components/schemas/DetectionMethod"},"alert_name":{"type":"string"},"severity":{"$ref":"#/components/schemas/SeverityEnum"},"scan_id":{"type":"string"},"issue_id":{"type":"string"}},"required":["resolution_comment","resolution_reason","resolution_status","assignee","branch","run_id","pull_request_id","repo_id","created","file_path","asset_name","detection_method","alert_name","severity","scan_id","issue_id"],"type":"object"},"ResolutionReason":{"enum":["Resolved - Known Issue","Resolved - Duplicate Incident","Resolved - False Positive","Resolved - Other","Resolved - True Positive","Resolved - Security Testing","Resolved - Dismissed","Resolved - Fixed","Resolved - Auto Resolve","Resolved - Threat Handled"],"type":"string"},"ResolutionStatus":{"enum":["New","Under Investigation","Resolved"],"type":"string"},"DetectionMethod":{"enum":["Secrets Security","Attack Path","Cve Security","Operational Risk Security","License Security","IaC Security","CIEM Scanner","API Traffic Monitor","API Posture Scanner","CLI Scanner","Agentless Disk Scanner","Kubernetes Scanner","Compute Policy","CSPM Scanner"],"type":"string"},"SeverityEnum":{"enum":["Critical","High","Medium","Low"],"type":"string"}}}}
```

## List AppSec scan findings

> Get a list of the findings discovered in the scan specified by scan ID.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"Scan management","description":"APIs for managing scans"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/scans/{scanId}/findings":{"get":{"operationId":"GetScanFindings","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ScanFindingsResponse"},"type":"array"}}}}},"tags":["Scan management"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"in":"path","name":"scanId","required":true,"schema":{"type":"string"}},{"in":"query","name":"severity","required":false,"schema":{"$ref":"#/components/schemas/SeverityEnum"}},{"in":"query","name":"offset","required":false,"schema":{"format":"double","type":"number","default":0}},{"in":"query","name":"limit","required":false,"schema":{"format":"double","type":"number","default":100}}],"summary":"List AppSec scan findings","description":"Get a list of the findings discovered in the scan specified by scan ID.\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on."}}},"components":{"schemas":{"ScanFindingsResponse":{"properties":{"scan_source":{"$ref":"#/components/schemas/ScanType"},"git_user":{"type":"string"},"first_hash_time":{"type":"string"},"first_hash":{"type":"string"},"platform_id":{"type":"string"},"branch":{"type":"string"},"detection_method":{"$ref":"#/components/schemas/DetectionMethod"},"file_path":{"type":"string"},"description":{"type":"string"},"last_observed":{"type":"string"},"first_observed":{"type":"string"},"suppression_type":{"$ref":"#/components/schemas/SuppressionType"},"data_source":{"$ref":"#/components/schemas/DataSource"},"name":{"type":"string"},"category":{"type":"string"},"asset_id":{"type":"string"},"asset_name":{"type":"string"},"severity":{"$ref":"#/components/schemas/SeverityEnum"},"scan_id":{"type":"string"},"issue_name":{"type":"string"}},"required":["scan_source","git_user","first_hash_time","first_hash","platform_id","branch","detection_method","file_path","description","last_observed","first_observed","suppression_type","data_source","name","category","asset_id","asset_name","severity","scan_id","issue_name"],"type":"object"},"ScanType":{"enum":["pr","cicd","periodic"],"type":"string"},"DetectionMethod":{"enum":["Secrets Security","Attack Path","Cve Security","Operational Risk Security","License Security","IaC Security","CIEM Scanner","API Traffic Monitor","API Posture Scanner","CLI Scanner","Agentless Disk Scanner","Kubernetes Scanner","Compute Policy","CSPM Scanner"],"type":"string"},"SuppressionType":{"enum":["Inline"],"type":"string"},"DataSource":{"enum":["GitHub","GitLab","Bitbucket","Azure Repos","Bitbucket Server","Bitbucket DataCenter","GitLab Dedicated","GitHub Enterprise","GitLab Self-Managed","Aws Code Commit"],"type":"string"},"SeverityEnum":{"enum":["Critical","High","Medium","Low"],"type":"string"}}}}
```

## Rerun a repository scan

> Create a repository scan by specifying the branch name.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

```json
{"openapi":"3.0.0","info":{"title":"ASPM, CICD and Application Security APIs","version":"Cortex Cloud"},"tags":[{"name":"Scan management","description":"APIs for managing scans"}],"servers":[{"url":"https://api-yourfqdn"}],"security":[],"paths":{"/public_api/appsec/v1/scan/repository/{repositoryId}":{"post":{"operationId":"ScanRepository","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ScanRepositorySuccessResponse"},{"$ref":"#/components/schemas/ScanFailureResponse"}]}}}}},"tags":["Scan management"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true},{"in":"path","name":"repositoryId","required":true,"schema":{"type":"string"}},{"schema":{"type":"boolean"},"in":"query","name":"scanFullGitHistory"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicScanRepositoryInput"}}}},"summary":"Rerun a repository scan","description":"Create a repository scan by specifying the branch name.\n\n**Required license:** Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on."}}},"components":{"schemas":{"ScanRepositorySuccessResponse":{"properties":{"metadata":{"properties":{"scan_id":{"type":"string"}},"required":["scan_id"],"type":"object"}},"required":["metadata"],"type":"object","additionalProperties":false},"ScanFailureResponse":{"properties":{"err_msg":{"type":"string"},"metadata":{"properties":{},"additionalProperties":{},"type":"object"}},"required":["err_msg","metadata"],"type":"object","additionalProperties":false},"PublicScanRepositoryInput":{"properties":{"branchName":{"type":"string"}},"type":"object","additionalProperties":false,"title":""}}}}
```


---

# 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-cloud-api/aspm-cicd-and-application-security/scan-management.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.