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.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/palo-alto-networks-scans-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Palo Alto Networks Scans API
x-refined-note:
- x-description-source differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged Scans across 10 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-networks-scans-api-openapi.yml, palo-alto-prisma-airs-ai-red-teaming-api-openapi-original.yml, palo-alto-prisma-airs-scan-scan-service-latest-openapi.yaml, palo-alto-prisma-cloud-code-security-api-openapi-original.yml, palo-alto-prisma-cloud-compute-api-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.prismacloud.io
- url: PATH_TO_CONSOLE
- url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
description: AIOps for NGFW BPA API production server.
- url: https://api.sase.paloaltonetworks.com/ai-red-teaming
description: Prisma AIRS AI Red Teaming API production server.
- 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
- url: https://api.prismacloud.io/code/api/v1
description: Prisma Cloud Code Security API (US region 1).
- url: https://api2.prismacloud.io/code/api/v1
description: Prisma Cloud Code Security API (US region 2).
- url: https://api.eu.prismacloud.io/code/api/v1
description: Prisma Cloud Code Security API (EU).
- url: https://api.anz.prismacloud.io/code/api/v1
description: Prisma Cloud Code Security API (ANZ).
- url: https://api.sg.prismacloud.io/code/api/v1
description: Prisma Cloud Code Security API (Singapore).
- url: https://api.ca.prismacloud.io/code/api/v1
description: Prisma Cloud Code Security API (Canada).
- url: https://{console}/api/v1
description: Prisma Cloud Compute Console API.
variables:
console:
default: console.example.com
description: Address of the Prisma Cloud Compute Console. For SaaS deployments, use the address provided in Prisma Cloud under Compute > Manage > System > Utilities.
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/scans:
post:
operationId: startVulnerabilityScan
summary: Palo Alto Networks Start Vulnerability Scan
description: Starts a new AI vulnerability scan against a registered target. Specify the attack categories to test and optionally provide custom prompts to supplement the built-in attack library. The scan runs asynchronously; use GET /v1/scans/{scan_id} to monitor progress and GET /v1/scans/{scan_id}/results to retrieve the completed report.
tags:
- Scans
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScanRequest'
examples:
StartVulnerabilityScanRequestExample:
summary: Default startVulnerabilityScan request
x-microcks-default: true
value:
target_id: '645262'
attack_categories:
- example-attack_categories_item
- example-attack_categories_item
custom_prompts:
- example-custom_prompts_item
- example-custom_prompts_item
max_attacks_per_category: 740
responses:
'201':
description: Vulnerability scan started successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Scan'
examples:
StartVulnerabilityScan201Example:
summary: Default startVulnerabilityScan 201 response
x-microcks-default: true
value:
scan_id: '588456'
target_id: '410241'
target_name: Production Agent 95
status: running
attack_categories:
- example-attack_categories_item
progress: 0.36
total_attacks: 275
completed_attacks: 880
vulnerabilities_found: 746
error_message: example-error_message
started_at: '2025-08-08T22:13:06Z'
completed_at: '2024-11-03T18:50:01Z'
'400':
description: Invalid request body or target not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
StartVulnerabilityScan400Example:
summary: Default startVulnerabilityScan 400 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
'401':
description: Invalid or missing Bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
StartVulnerabilityScan401Example:
summary: Default startVulnerabilityScan 401 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
'403':
description: Insufficient permissions.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
StartVulnerabilityScan403Example:
summary: Default startVulnerabilityScan 403 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
'409':
description: A scan is already in progress for this target.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
StartVulnerabilityScan409Example:
summary: Default startVulnerabilityScan 409 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
StartVulnerabilityScan500Example:
summary: Default startVulnerabilityScan 500 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- oauth2Bearer: []
servers:
- url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
description: AIOps for NGFW BPA API production server.
/v1/scans/{scan_id}:
get:
operationId: getScanStatus
summary: Palo Alto Networks Get Scan Status
description: Returns the current status and progress of a vulnerability scan. When status is completed, use GET /v1/scans/{scan_id}/results to retrieve the full vulnerability report.
tags:
- Scans
parameters:
- name: scan_id
in: path
required: true
description: Unique identifier of the vulnerability scan.
schema:
type: string
example: '734547'
responses:
'200':
description: Scan status returned.
content:
application/json:
schema:
$ref: '#/components/schemas/Scan'
examples:
GetScanStatus200Example:
summary: Default getScanStatus 200 response
x-microcks-default: true
value:
scan_id: '588456'
target_id: '410241'
target_name: Production Agent 95
status: running
attack_categories:
- example-attack_categories_item
progress: 0.36
total_attacks: 275
completed_attacks: 880
vulnerabilities_found: 746
error_message: example-error_message
started_at: '2025-08-08T22:13:06Z'
completed_at: '2024-11-03T18:50:01Z'
'401':
description: Invalid or missing Bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
GetScanStatus401Example:
summary: Default getScanStatus 401 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
'403':
description: Insufficient permissions.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
GetScanStatus403Example:
summary: Default getScanStatus 403 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
'404':
description: Scan not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
GetScanStatus404Example:
summary: Default getScanStatus 404 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
GetScanStatus500Example:
summary: Default getScanStatus 500 response
x-microcks-default: true
value:
error: example-error
message: Policy investigation blocked activity on activity suspicious configured configured suspicious.
request_id: f62400eb-5426-47bb-acc1-166eb163d06c
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
security:
- oauth2Bearer: []
servers:
- url: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
description: AIOps for NGFW BPA API production server.
/v1/scans/{scan_id}/results:
get:
operationId: getScanResults
summary: Palo Alto Networks Get Scan Results and Report
description: Returns the detailed vulnerability report for a completed scan. The report includes an overall risk score, vulnerability findings organized by attack category, specific attack prompts that succeeded, and remediation recommendations. Only available when the scan status is completed.
tags:
- Scans
parameters:
- name: scan_id
in: path
required: true
description: Unique identifier of the completed scan.
schema:
type: string
example: '783198'
# --- truncated at 32 KB (202 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-scans-api-openapi.yml