Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Sandbox API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-sandbox-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 3

$.info

$.paths['/api/v34.03/sandbox'].post

$.paths['/api/v34.04/sandbox'].post

OpenAPI Overlay

# 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 Sandbox API
  version: 1.0.0
extends: openapi/palo-alto-networks-sandbox-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: 2
- target: $.paths['/api/v34.03/sandbox'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a sandbox scan result (v34.03)
      effect: write
      questions:
      - Can I submit an image sandbox analysis result to the console through the older v34.03 API?
      - What does a v34.03 sandbox result carry, such as risk score and suspicious files?
      instructions:
      - text: Using API v34.03, add the sandbox scan result for image {imageName} with risk score {riskScore}.
        slots:
          imageName: requestBody.imageName
          riskScore: requestBody.riskScore
      - text: Via v34.03, record sandbox findings {findings} for image {image}.
        slots:
          findings: requestBody.findings
          image: requestBody.image
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sandbox'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a sandbox scan result (v34.04)
      effect: write
      questions:
      - On the newer v34.04 release, where do I upload what a container did when detonated?
      - Does v34.04 accept the processes, DNS lookups and listening ports seen during detonation?
      instructions:
      - text: Upload v34.04 detonation output for {imageName}, including processes {procs}.
        slots:
          imageName: requestBody.imageName
          procs: requestBody.procs
      - text: Store a v34.04 dynamic analysis verdict pass={pass} with scan duration {scanDuration}.
        slots:
          pass: requestBody.pass
          scanDuration: requestBody.scanDuration
      method: generated
      generated: '2026-09-26'