Palo Alto Networks Scan API
Operations for creating and managing scan jobs.
Operations 7
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
POST
/v1/scan/sync/request
Scan an AI prompt or response synchronously · Palo Alto Networks Submit a Synchronous AI Security Scan
#
Ask an LLM
“How do I check a user prompt or model response for threats and get the verdict right away?”
“Which AI security profile is applied when I scan a prompt in real time?”
Tell an agent
Scan contents {contents} synchronously with AI profile {ai_profile}.
Run a real-time AI security scan on {contents} under profile {ai_profile} with transaction ID {tr_id}.
POST
/v1/scan/async/request
Submit an asynchronous AI security scan · Palo Alto Networks Submit an Asynchronous AI Security Scan
#
Ask an LLM
“Can I queue AI prompt scans in the background and get a scan ID and report ID back?”
“What does an asynchronous AI security scan request return?”
Tell an agent
Submit an asynchronous AI security scan of {contents} using AI profile {ai_profile}.
Queue a background AI prompt scan and give me the scan_id and report_id.
GET
/v1/scan/async/results/{scan_id}
Get results of an asynchronous scan · Palo Alto Networks Get Asynchronous Scan Results
#
Ask an LLM
“Has my asynchronous prompt scan finished, and what did it detect?”
“Where do I poll for the verdict of a queued AI security scan?”
Tell an agent
Get the results of async scan {scan_id}.
Check whether scan {scan_id} is done and show its detections.
Ask an LLM
“How do I start a new red-team style scan against one of my AI targets?”
“What do I need to supply to create a scan job?”
Tell an agent
Create a {job_type} scan named {name} against target {target}.
Start scan job {name} on {target} with metadata {job_metadata}.
Ask an LLM
“Which scan jobs are running or finished for my AI targets?”
“Can I filter scan jobs by status, type or target?”
Tell an agent
List my scan jobs with status {status}.
Show scan jobs for target {target_id} whose name matches {search}.
Ask an LLM
“What's the current status and configuration of a specific scan job?”
“Can I look up one scan job by its ID?”
Tell an agent
Show the details of scan job {job_id}.
Get the status of scan {job_id}.
Ask an LLM
“How do I stop a scan job that's still running?”
“Does aborting a scan cancel its workflow?”
Tell an agent destructive · confirm first
Abort running scan job {job_id}.
Cancel the workflow for scan {job_id}.