Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Report API

18 actions 18 updates phrasing extends openapi/palo-alto-networks-report-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 18 · first 16 shown; the file carries all of them

$.info
$.paths['/v1/report/static/{job_id}/list-attacks'].get
$.paths['/v1/report/static/{job_id}/attack/{attack_id}'].get
$.paths['/v1/report/static/{job_id}/report'].get
$.paths['/v1/report/static/{job_id}/runtime-policy-config'].get
$.paths['/v1/report/static/{job_id}/remediation'].get
$.paths['/v1/report/dynamic/{job_id}/report'].get
$.paths['/v1/report/dynamic/{job_id}/runtime-policy-config'].get
$.paths['/v1/report/dynamic/{job_id}/remediation'].get
$.paths['/v1/report/dynamic/{job_id}/list-goals'].get
$.paths['/v1/report/dynamic/{job_id}/goal/{goal_id}/list-streams'].get
$.paths['/v1/report/dynamic/stream/{stream_id}'].get
$.paths['/v1/report/{job_id}/download'].get
$.paths['/v1/report/{job_id}/generate-partial-report'].post
$.paths['/v1/report/static/{job_id}/attack-multi-turn/{attack_id}'].get
$.paths['/get/report'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Palo Alto Networks Report API
  version: 1.0.0
extends: openapi/palo-alto-networks-report-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/v1/report/static/{job_id}/list-attacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List attacks run in an attack library scan
      effect: read
      questions:
      - Which attacks succeeded against my AI model in an attack library scan?
      - Can I filter scan attacks by category, severity or compliance framework?
      - How do I see only document-based attacks from a red teaming scan?
      instructions:
      - text: List the attacks in attack library scan {job_id} with status {status}.
        slots:
          job_id: path.job_id
          status: query.status
      - text: Show attacks of category {category} and severity {severity} in scan {job_id}.
        slots:
          job_id: path.job_id
          category: query.category
          severity: query.severity
      - text: List file-modality attacks mapped to compliance framework {compliance} in scan {job_id}.
        slots:
          job_id: path.job_id
          compliance: query.compliance
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/static/{job_id}/attack/{attack_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one single-turn attack's details
      effect: read
      questions:
      - What did the model output for a specific attack in my scan?
      - Which framework techniques does a single attack map to?
      instructions:
      - text: Get details of attack {attack_id} in scan {job_id}.
        slots:
          job_id: path.job_id
          attack_id: path.attack_id
      - text: Show the model outputs and techniques for single-turn attack {attack_id} from job {job_id}.
        slots:
          job_id: path.job_id
          attack_id: path.attack_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/static/{job_id}/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the attack library scan report
      effect: read
      questions:
      - Where do I read the summary report for an attack library red teaming scan?
      - Why is my attack library report locked when the scan only partially completed?
      instructions:
      - text: Get the attack library report for scan {job_id}.
        slots:
          job_id: path.job_id
      - text: Summarize the red teaming results of attack library job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/static/{job_id}/runtime-policy-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get runtime profile suggested by a library scan
      effect: read
      questions:
      - What runtime security profile is recommended from my attack library scan?
      - Can an attack library scan tell me how to configure runtime protection?
      instructions:
      - text: Get the runtime security profile for attack library scan {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the recommended runtime protection settings from library job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/static/{job_id}/remediation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get remediation steps from a library scan
      effect: read
      questions:
      - Beyond runtime protection, what other fixes does an attack library scan suggest?
      - Which remediation measures came out of my model's attack library scan?
      instructions:
      - text: Get the remediation measures for attack library scan {job_id}.
        slots:
          job_id: path.job_id
      - text: List other fixes recommended by library job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/dynamic/{job_id}/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the agent scan report
      effect: read
      questions:
      - Where do I see the results of a dynamic agent red teaming scan?
      - What did an agent scan find about my AI agent's weaknesses?
      instructions:
      - text: Get the agent scan report for job {job_id}.
        slots:
          job_id: path.job_id
      - text: Summarize dynamic agent scan {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/dynamic/{job_id}/runtime-policy-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get runtime profile suggested by an agent scan
      effect: read
      questions:
      - Which runtime security profile should protect my agent based on its dynamic scan?
      - Does an agent scan produce a runtime protection configuration?
      instructions:
      - text: Get the runtime security profile from agent scan {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the runtime protection settings recommended by dynamic job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/dynamic/{job_id}/remediation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get remediation steps from an agent scan
      effect: read
      questions:
      - What should I fix in my AI agent after a dynamic scan?
      - Which non-runtime remediations did an agent scan recommend?
      instructions:
      - text: Get the remediation measures for agent scan {job_id}.
        slots:
          job_id: path.job_id
      - text: List the fixes the dynamic scan {job_id} recommends for my agent.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/dynamic/{job_id}/list-goals'].get
  update:
    x-apievangelist-phrasing:
      intent: List goals tested in an agent scan
      effect: read
      questions:
      - Which attacker goals did the agent scan try to achieve?
      - Can I search agent scan goals by type, category or status?
      instructions:
      - text: List the goals of agent scan {job_id}.
        slots:
          job_id: path.job_id
      - text: Find goals in agent scan {job_id} of category {goal_category} with status {status}.
        slots:
          job_id: path.job_id
          goal_category: query.goal_category
          status: query.status
      - text: Search agent scan {job_id} goals for {search}.
        slots:
          job_id: path.job_id
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/dynamic/{job_id}/goal/{goal_id}/list-streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List the attack streams for an agent scan goal
      effect: read
      questions:
      - How was a particular goal pursued in my agent scan?
      - What streams of attempts were run for one agent scan goal?
      instructions:
      - text: List the streams for goal {goal_id} in agent scan {job_id}.
        slots:
          job_id: path.job_id
          goal_id: path.goal_id
      - text: Show how goal {goal_id} of job {job_id} was attempted.
        slots:
          job_id: path.job_id
          goal_id: path.goal_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/dynamic/stream/{stream_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get iteration details for an agent scan stream
      effect: read
      questions:
      - Can I see each iteration of a single agent scan stream?
      - What happened turn by turn in one stream of a dynamic scan?
      instructions:
      - text: Get the details of agent scan stream {stream_id}.
        slots:
          stream_id: path.stream_id
      - text: Show the iteration data for stream {stream_id}.
        slots:
          stream_id: path.stream_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/{job_id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download red teaming scan report files
      effect: read
      questions:
      - Can I export a red teaming scan report as CSV or JSON?
      - How do I download all report files for a scan job?
      instructions:
      - text: Download the report for job {job_id} as {file_format}.
        slots:
          job_id: path.job_id
          file_format: query.file_format
      - text: Export every report file format for scan {job_id} using format {file_format}.
        slots:
          job_id: path.job_id
          file_format: query.file_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/{job_id}/generate-partial-report'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock a partially complete scan report
      effect: write
      questions:
      - How do I unlock the report for a scan that only partially completed?
      - Does unlocking a partial scan report use up a quota credit?
      instructions:
      - text: Unlock the partial report for job {job_id}.
        slots:
          job_id: path.job_id
      - text: Spend a quota credit to generate the partial report for scan {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/report/static/{job_id}/attack-multi-turn/{attack_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a multi-turn attack's details
      effect: read
      questions:
      - How do I review the full conversation of a multi-turn attack against my model?
      - Which techniques were used across the turns of a multi-turn jailbreak attempt?
      instructions:
      - text: Get multi-turn attack {attack_id} from scan {job_id}.
        slots:
          job_id: path.job_id
          attack_id: path.attack_id
      - text: Show every turn's output for multi-turn attack {attack_id} in job {job_id}.
        slots:
          job_id: path.job_id
          attack_id: path.attack_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/get/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a WildFire analysis report
      effect: read
      questions:
      - How do I get the WildFire sandbox report for a file hash?
      - Can I get WildFire behavioral analysis as a PDF or XML?
      instructions:
      - text: Get the WildFire report for hash {hash} in {format} format.
        slots:
          hash: requestBody.hash
          format: requestBody.format
      - text: Show the network and registry activity WildFire recorded for sample {hash} as {format}.
        slots:
          hash: requestBody.hash
          format: requestBody.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/get/sample'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a WildFire malware sample
      effect: read
      questions:
      - Can I download the original file WildFire judged as malware?
      - Which samples am I allowed to download from WildFire?
      instructions:
      - text: Download the WildFire sample with hash {hash}.
        slots:
          hash: requestBody.hash
      - text: Fetch the original malicious file {hash} from WildFire.
        slots:
          hash: requestBody.hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/get/pcap'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a WildFire sample's packet capture
      effect: read
      questions:
      - How do I get the network traffic a sample generated during WildFire detonation?
      - Can I choose which sandbox platform's PCAP to download?
      instructions:
      - text: Download the PCAP for sample {hash} on platform {platform}.
        slots:
          hash: requestBody.hash
          platform: requestBody.platform
      - text: Get the packet capture WildFire recorded for {hash} on sandbox platform {platform}.
        slots:
          hash: requestBody.hash
          platform: requestBody.platform
      method: generated
      generated: '2026-09-26'