Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Operations and Troubleshooting Device Operations API

10 actions 10 updates phrasing extends openapi/palo-alto-networks-device-operations-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 10

$.info
$.paths['/local-config/versions'].get
$.paths['/local-config/download'].get
$.paths['/jobs/route-table'].post
$.paths['/jobs/dns-proxy'].post
$.paths['/jobs/fib-table'].post
$.paths['/jobs/logging-service-forwarding-status'].post
$.paths['/jobs/device-interfaces'].post
$.paths['/jobs/device-rules'].post
$.paths['/jobs/bgp-policy-export'].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 Operations and Troubleshooting Device Operations API
  version: 1.0.0
extends: openapi/palo-alto-networks-device-operations-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: 9
- target: $.paths['/local-config/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List local config versions for a device
      effect: read
      questions:
      - How can I see the history of local configurations pushed to a firewall?
      - Which local config version is currently on a device?
      instructions:
      - text: List local configuration versions for device {device}.
        slots:
          device: query.device
      - text: Show the local config version history of {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-config/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a device’s local config file
      effect: read
      questions:
      - Can I download the actual XML config file that was pushed to a device?
      - Where do I grab a backup of a specific local config version?
      instructions:
      - text: Download local config version {version} for device {device}.
        slots:
          version: query.version
          device: query.device
      - text: Get the XML of local config {version} from {device} for backup.
        slots:
          version: query.version
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/route-table'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job to fetch device route tables
      effect: read
      questions:
      - Can I pull the route table from several firewalls at once?
      - Is the advanced route table available as well as the regular one?
      instructions:
      - text: Start a job to retrieve the route table from devices {devices}.
        slots:
          devices: requestBody.devices
      - text: Fetch the advanced route table from {devices}.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/dns-proxy'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job to fetch the DNS proxy table
      effect: read
      questions:
      - How do I see the DNS proxy table on my firewalls?
      - Can I retrieve DNS proxy entries from multiple devices in one job?
      instructions:
      - text: Start a job to retrieve the DNS proxy table from {devices}.
        slots:
          devices: requestBody.devices
      - text: Get DNS proxy entries from devices {devices}.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/fib-table'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job to fetch the FIB table
      effect: read
      questions:
      - Can I retrieve the forwarding information base from a firewall?
      - What's the way to get FIB entries from several devices?
      instructions:
      - text: Start a job to retrieve the FIB table from {devices}.
        slots:
          devices: requestBody.devices
      - text: Pull the forwarding information base from devices {devices}.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/logging-service-forwarding-status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check log forwarding status on devices
      effect: read
      questions:
      - Are my firewalls successfully forwarding logs to the logging service?
      - Can I check logging service forwarding status across devices?
      instructions:
      - text: Start a job to check logging service forwarding status on {devices}.
        slots:
          devices: requestBody.devices
      - text: Check whether {devices} are forwarding logs to the logging service.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/device-interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job to fetch device interfaces
      effect: read
      questions:
      - How can I list the network interfaces on a firewall remotely?
      - Can I get interface details from more than one device at a time?
      instructions:
      - text: Start a job to retrieve network interfaces from {devices}.
        slots:
          devices: requestBody.devices
      - text: Get the interface list from devices {devices}.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/device-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job to fetch rules from devices
      effect: read
      questions:
      - Can I retrieve the rules actually running on a device?
      - What rules are loaded on one or more of my firewalls?
      instructions:
      - text: Start a job to retrieve the rules on {devices}.
        slots:
          devices: requestBody.devices
      - text: Pull the device rules from {devices}.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/bgp-policy-export'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a BGP policy export job on devices
      effect: read
      questions:
      - Can I export BGP policy from my firewalls?
      - Which endpoint gives me a BGP policy export from multiple devices?
      instructions:
      - text: Start a BGP policy export job on {devices}.
        slots:
          devices: requestBody.devices
      - text: Export BGP policy from devices {devices}.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'