Palo Alto Networks Scans API
The Scans API from Palo Alto Networks — 14 operation(s) for scans.
The Scans API from Palo Alto Networks — 14 operation(s) for scans.
openapi: 3.2.0
info:
title: Palo Alto Networks Scans API
version: '1.0'
description: 'Operations tagged Scans across 6 of this provider''s published API definitions: palo-alto-code-scans-openapi.json, palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json, palo-alto-prisma-airs-scan-scan-service-latest-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.prismacloud.io
- url: PATH_TO_CONSOLE
- url: https://service.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for US regions
- url: https://service-de.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for EU (Germany) regions
- url: https://service-in.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for India regions
- url: https://service-sg.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for Singapore regions
tags:
- name: Scans
paths:
/code/api/v1/scans/integrations:
post:
description: 'Trigger asynchronous scan of all resources to refresh the current state at Prisma Cloud Application Security.
The scan will update resources configured in cloud providers (AWS/Azure/GCP)
and IaC resources in the main branch at each version control system (Github/Gitlab/Bitbucket).
Please note: A new scan will not be triggered only if there is another running execution.'
operationId: scanIntegrations
parameters: []
responses:
'201':
content:
application/json:
schema:
properties:
isExecuted:
type: boolean
message:
type: string
required:
- message
- isExecuted
type: object
description: Scan started
security:
- CustomAuthorizer: []
summary: Trigger a Scan
tags:
- Scans
x-codeSamples:
- lang: Python + Requests
source: 'import requests
url = "https://api.prismacloud.io/code/api/v1/scans/integrations"
headers = {"authorization": "REPLACE_KEY_VALUE"}
response = requests.request("POST", url, headers=headers)
print(response.text)'
- lang: Shell + Curl
source: "curl --request POST \\\n --url https://api.prismacloud.io/code/api/v1/scans/integrations \\\n --header 'authorization: REPLACE_KEY_VALUE'"
servers:
- url: https://api.prismacloud.io
/api/v34.03/scans:
get:
description: 'Get All CI Image Scan Results. GET /api/v34.03/scans on the Scans API. Takes 17 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Scan ID used in the image layers fetch.
'
in: query
name: _id
schema:
type: string
- description: 'Jenkins job name.
'
in: query
name: jobName
schema:
description: 'Jenkins job name.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Scan type.
'
in: query
name: type
schema:
description: 'Scan type.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates whether to filter on passed scans (true) or not (false).
'
in: query
name: pass
schema:
type: boolean
- description: 'Build number.
'
in: query
name: build
schema:
type: string
- description: 'Image ID of scanned image.
'
in: query
name: imageID
schema:
type: string
- description: 'Indicates if CVEs are mapped to image layer (true) or not (false).
'
in: query
name: layers
schema:
type: boolean
- description: 'Filters results by start datetime. Based on scan time.
'
in: query
name: from
schema:
format: date-time
type: string
- description: 'Filters results by end datetime. Based on scan time.
'
in: query
name: to
schema:
format: date-time
type: string
- description: 'List of fields to retrieve.
'
in: query
name: fields
schema:
description: 'List of fields to retrieve.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates if base image vulnerabilities are to be filtered (true) or not (false). Requires predefined base images that have already been scanned.
'
in: query
name: filterBaseImage
schema:
type: boolean
- description: 'Filters results by uaiID.
'
in: query
name: uaiID
schema:
type: string
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.CLIScanResult'
description: ''
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: get-scans
summary: Get All CI Image Scan Results
x-description-source: desc/scans/get.md
post:
description: 'Add CLI Scan Result. POST /api/v34.03/scans on the Scans API. Takes an optional request body. Documented responses: 200.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/shared.CLIScanResult'
responses:
'200':
description: OK
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: post-scans
summary: Add CLI Scan Result
x-description-source: desc/scans/post.md
/api/v34.03/scans/download:
get:
description: 'Download CI Image Scan Results. GET /api/v34.03/scans/download on the Scans API. Takes 17 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Scan ID used in the image layers fetch.
'
in: query
name: _id
schema:
type: string
- description: 'Jenkins job name.
'
in: query
name: jobName
schema:
description: 'Jenkins job name.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Scan type.
'
in: query
name: type
schema:
description: 'Scan type.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates whether to filter on passed scans (true) or not (false).
'
in: query
name: pass
schema:
type: boolean
- description: 'Build number.
'
in: query
name: build
schema:
type: string
- description: 'Image ID of scanned image.
'
in: query
name: imageID
schema:
type: string
- description: 'Indicates if CVEs are mapped to image layer (true) or not (false).
'
in: query
name: layers
schema:
type: boolean
- description: 'Filters results by start datetime. Based on scan time.
'
in: query
name: from
schema:
format: date-time
type: string
- description: 'Filters results by end datetime. Based on scan time.
'
in: query
name: to
schema:
format: date-time
type: string
- description: 'List of fields to retrieve.
'
in: query
name: fields
schema:
description: 'List of fields to retrieve.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates if base image vulnerabilities are to be filtered (true) or not (false). Requires predefined base images that have already been scanned.
'
in: query
name: filterBaseImage
schema:
type: boolean
- description: 'Filters results by uaiID.
'
in: query
name: uaiID
schema:
type: string
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
description: OK
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: get-scans-download
summary: Download CI Image Scan Results
x-description-source: desc/scans/download_get.md
/api/v34.03/scans/{id}:
get:
description: 'Get CI Image Scan Results. GET /api/v34.03/scans/{id} on the Scans API. Takes 1 path parameter. Documented responses: 200.'
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: OK
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: get-scans-id
summary: Get CI Image Scan Results
x-description-source: desc/scans/id_get.md
/api/v34.04/scans:
get:
description: 'Get All CI Image Scan Results. GET /api/v34.04/scans on the Scans API. Takes 17 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Scan ID used in the image layers fetch.
'
in: query
name: _id
schema:
type: string
- description: 'Jenkins job name.
'
in: query
name: jobName
schema:
description: 'Jenkins job name.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Scan type.
'
in: query
name: type
schema:
description: 'Scan type.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates whether to filter on passed scans (true) or not (false).
'
in: query
name: pass
schema:
type: boolean
- description: 'Build number.
'
in: query
name: build
schema:
type: string
- description: 'Image ID of scanned image.
'
in: query
name: imageID
schema:
type: string
- description: 'Indicates if CVEs are mapped to image layer (true) or not (false).
'
in: query
name: layers
schema:
type: boolean
- description: 'Filters results by start datetime. Based on scan time.
'
in: query
name: from
schema:
format: date-time
type: string
- description: 'Filters results by end datetime. Based on scan time.
'
in: query
name: to
schema:
format: date-time
type: string
- description: 'List of fields to retrieve.
'
in: query
name: fields
schema:
description: 'List of fields to retrieve.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates if base image vulnerabilities are to be filtered (true) or not (false). Requires predefined base images that have already been scanned.
'
in: query
name: filterBaseImage
schema:
type: boolean
- description: 'Filters results by uaiID.
'
in: query
name: uaiID
schema:
type: string
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.CLIScanResult'
description: ''
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: get-scans
summary: Get All CI Image Scan Results
x-description-source: desc/scans/get.md
post:
description: 'Add CLI Scan Result. POST /api/v34.04/scans on the Scans API. Takes an optional request body. Documented responses: 200.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/shared.CLIScanResult'
responses:
'200':
description: OK
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: post-scans
summary: Add CLI Scan Result
x-description-source: desc/scans/post.md
/api/v34.04/scans/download:
get:
description: 'Download CI Image Scan Results. GET /api/v34.04/scans/download on the Scans API. Takes 17 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Scan ID used in the image layers fetch.
'
in: query
name: _id
schema:
type: string
- description: 'Jenkins job name.
'
in: query
name: jobName
schema:
description: 'Jenkins job name.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Scan type.
'
in: query
name: type
schema:
description: 'Scan type.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates whether to filter on passed scans (true) or not (false).
'
in: query
name: pass
schema:
type: boolean
- description: 'Build number.
'
in: query
name: build
schema:
type: string
- description: 'Image ID of scanned image.
'
in: query
name: imageID
schema:
type: string
- description: 'Indicates if CVEs are mapped to image layer (true) or not (false).
'
in: query
name: layers
schema:
type: boolean
- description: 'Filters results by start datetime. Based on scan time.
'
in: query
name: from
schema:
format: date-time
type: string
- description: 'Filters results by end datetime. Based on scan time.
'
in: query
name: to
schema:
format: date-time
type: string
- description: 'List of fields to retrieve.
'
in: query
name: fields
schema:
description: 'List of fields to retrieve.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Indicates if base image vulnerabilities are to be filtered (true) or not (false). Requires predefined base images that have already been scanned.
'
in: query
name: filterBaseImage
schema:
type: boolean
- description: 'Filters results by uaiID.
'
in: query
name: uaiID
schema:
type: string
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
description: OK
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: get-scans-download
summary: Download CI Image Scan Results
x-description-source: desc/scans/download_get.md
/api/v34.04/scans/{id}:
get:
description: 'Get CI Image Scan Results. GET /api/v34.04/scans/{id} on the Scans API. Takes 1 path parameter. Documented responses: 200.'
parameters:
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: OK
default:
description: ''
tags:
- Scans
x-prisma-cloud-target-env:
permission: monitorCI
operationId: get-scans-id
summary: Get CI Image Scan Results
x-description-source: desc/scans/id_get.md
/v1/scan/sync/request:
post:
summary: Send a Synchronous Scan Request
description: Post a scan request containing prompt or model response that returns a synchronous scan response
security:
- x-pan-token: []
operationId: ScanSyncRequest
tags:
- Scans
requestBody:
description: Scan request object
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScanRequest'
responses:
'200':
description: successfully scanned request
content:
application/json:
schema:
$ref: '#/components/schemas/ScanResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'413':
$ref: '#/components/responses/RequestTooLarge'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
default:
description: error
content:
application/json:
schema:
properties:
message:
type: string
error:
type: string
servers:
- url: https://service.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for US regions
- url: https://service-de.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for EU (Germany) regions
- url: https://service-in.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for India regions
- url: https://service-sg.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for Singapore regions
/v1/scan/async/request:
post:
summary: Send an Asynchronous Scan Request
description: Post a scan request that returns an asynchronous scan response with the scan_id and report_id
security:
- x-pan-token: []
operationId: ScanAsyncRequest
tags:
- Scans
requestBody:
description: A list of scan request objects
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AsyncScanRequest'
responses:
'200':
description: successfully scanned request
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncScanResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthenticated'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'413':
$ref: '#/components/responses/RequestTooLarge'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'429':
$ref: '#/components/responses/TooManyRequests'
default:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: https://service.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for US regions
- url: https://service-de.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for EU (Germany) regions
- url: https://service-in.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for India regions
- url: https://service-sg.api.aisecurity.paloaltonetworks.com
description: Prisma AIRS API service URL for Singapore regions
components:
schemas:
vuln.Application:
description: Application represents a detected application
properties:
installedFromPackage:
description: 'Indicates that the app was installed as an OS package.
'
type: boolean
knownVulnerabilities:
description: 'Total number of vulnerabilities for this application.
'
type: integer
layerTime:
description: 'Image layer to which the application belongs - layer creation time.
'
format: int64
type: integer
md5:
description: 'MD5 is the md5sum of the app.
'
type: string
name:
description: 'Name of the application.
'
type: string
originPackageName:
description: 'OriginPackageName is the name of the app origin package.
'
type: string
path:
description: 'Path of the detected application.
'
type: string
rpmModule:
description: 'RPMModule represents the RPM module in which this application is included.
'
type: string
service:
description: 'Service indicates whether the application is installed as a service.
'
type: boolean
version:
description: 'Version of the application.
'
type: string
type: object
vulnerability.ExploitType:
description: ExploitType represents the source of an exploit
enum:
- - ''
- exploit-db
- exploit-windows
- cisa-kev
type: string
wildfire.Usage:
description: Usage holds wildfire usage stats, period for the usage varies with context
properties:
bytes:
description: 'Bytes is the total number of bytes uploaded to the WildFire API.
'
format: int64
type: integer
queries:
description: 'Queries is the number of queries to the WildFire API.
'
format: int64
type: integer
uploads:
description: 'Uploads is the number of uploads to the WildFire API.
'
format: int64
type: integer
type: object
shared.ImageTag:
description: ImageTag represents an image repository and its associated tag or registry digest
properties:
digest:
description: 'Image digest (requires V2 or later registry).
'
type: string
id:
description: 'ID of the image.
'
type: string
registry:
description: 'Registry name to which the image belongs.
'
type: string
repo:
description: 'Repository name to which the image belongs.
'
type: string
tag:
description: 'Image tag.
'
type: string
type: object
common.NetworkDeviceIP:
description: NetworkDeviceIP represents a network device name and address pair
properties:
ip:
description: 'Network device IPv4 address.
'
type: string
name:
description: 'Network device name.
'
type: string
type: object
common.CloudMetadata:
description: CloudMetadata is the metadata for a cloud provider managed asset (e.g., as part of AWS/GCP/Azure/OCI)
properties:
accountID:
description: 'Cloud account ID.
'
type: string
awsExecutionEnv:
description: 'AWS execution environment (e.g. EC2/Fargate).
'
type: string
azure:
$ref: '#/components/schemas/common.AzureMetadata'
gcp:
$ref: '#/components/schemas/common.GCPCloudMetadata'
image:
description: 'The name of the image the cloud managed host or container is based on.
'
type: string
labels:
description: 'Cloud provider metadata labels.
'
items:
$ref: '#/components/schemas/common.ExternalLabel'
type: array
name:
description: 'Resource name.
'
type: string
ociTenantID:
description: 'OCI Tenant ID.
'
type: string
provider:
$ref: '#/components/schemas/common.CloudProvider'
region:
description: 'Resource''s region.
'
type: string
resourceID:
description: 'Unique ID of the resource.
'
type: string
resourceURL:
description: 'Server-defined URL for the resource.
'
type: string
type:
description: 'Instance type.
'
type: string
vmID:
description: 'Azure unique vm ID.
'
type: string
vmImageID:
description: 'VMImageID holds the VM instance''s image ID.
'
type: string
type: object
waas.UnprotectedProcess:
description: UnprotectedProcess holds unprotected processes alongside the port
properties:
port:
description: 'Port is the process port.
'
type: integer
process:
description: 'Process is the process name.
'
type: string
tls:
description: 'TLS is the port TLS indication.
'
type: boolean
type: object
shared.ScanResultType:
description: ScanResultType represents a cloud scan result type
enum:
- - aws-ecr
- aws-lambda
- aws-ecs-task-definition
- aws-ec2
- aws-eks
- aws-eks-fargate-container
- aws-ecs
- aws-s3
- aws-config
- aws-cloud-trail
- aws-kms
- aws-cloud-watch
- aws-sns
- aws-security-hub
- aws-secrets-manager
- aws-parameter-store
- azure-acr
- azure-functions
- azure-aks
- azure-aci
- azure-vm
- gcp-gcr
- gcp-gcf
- gcp-gke
- gcp-vm
- gcp-artifact
- gcp-cloud-run-service
- oci-instance
type: string
common.Color:
description: Color is a hexadecimal representation of color code value
type: string
common.ACIMetadata:
properties:
containerGroup:
description: '.
'
type: string
type: object
secrets.SecretScanMetrics:
description: SecretScanMetrics represents metrics collected during secret scan
properties:
failedScans:
description: 'FailedScans represents number of failed scans caused by scanner errors.
'
format: int64
type: integer
foundSecrets:
description: 'FoundSecrets represents number of detected secrets.
'
type: integer
scanTime:
description: 'ScanTime represents cumulative secret scan time in microseconds.
'
format: int64
type: integer
scanTimeouts:
description: 'ScanTimeouts represents number of failed scans caused by timeout.
'
format: int64
type: integer
scannedFileSize:
description: 'ScannedFileSize represents accumulated size of scanned files.
'
format: int64
type: integer
scannedFiles:
description: 'ScannedFiles represents number of text files scanned for secrets.
'
format: int64
type: integer
totalBytes:
description: 'TotalBytes represents accumulated file size.
'
format: int64
type: integer
totalFiles:
description: 'TotalFiles represents number of files read for
# --- truncated at 32 KB (156 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-scans-api-openapi.yml