Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Hosts API

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

$.info
$.paths['/api/v34.03/hosts'].get
$.paths['/api/v34.03/hosts/download'].get
$.paths['/api/v34.03/hosts/evaluate'].post
$.paths['/api/v34.03/hosts/info'].get
$.paths['/api/v34.03/hosts/scan'].post
$.paths['/api/v34.04/hosts'].get
$.paths['/api/v34.04/hosts/download'].get
$.paths['/api/v34.04/hosts/evaluate'].post
$.paths['/api/v34.04/hosts/info'].get
$.paths['/api/v34.04/hosts/scan'].post
$.paths['/hosts'].get

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 Hosts API
  version: 1.0.0
extends: openapi/palo-alto-networks-hosts-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: 11
- target: $.paths['/api/v34.03/hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get host scan results (v34.03)
      effect: read
      questions:
      - On the v34.03 API, which hosts have critical vulnerabilities in their scan results?
      - Can the older v34.03 host scan results be filtered by OS distribution?
      instructions:
      - text: Get v34.03 host scan results for hostname {hostname}.
        slots:
          hostname: query.hostname
      - text: Using API v34.03, list host scan results in cluster {clusters} with severity {normalizedSeverity}.
        slots:
          clusters: query.clusters
          normalizedSeverity: query.normalizedSeverity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/hosts/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download host scan results (v34.03)
      effect: read
      questions:
      - Can I download host scan results as a file through the v34.03 API?
      - Is it possible to export only agentless host scans with the v34.03 download endpoint?
      instructions:
      - text: Download v34.03 host scan results for distro {distro}.
        slots:
          distro: query.distro
      - text: Export the v34.03 host scan report for compliance rule {complianceRuleName}.
        slots:
          complianceRuleName: query.complianceRuleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/hosts/evaluate'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve hosts (v34.03)
      effect: read
      questions:
      - What does resolving hosts do in the v34.03 Hosts API?
      - Can I submit a list of images to the v34.03 host resolver?
      instructions:
      - text: 'Resolve these hosts with the v34.03 evaluate endpoint: {images}.'
        slots:
          images: requestBody.images
      - text: Run the v34.03 host resolution for my image list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/hosts/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get host information (v34.03)
      effect: read
      questions:
      - Can I get host information rather than full scan results on the v34.03 API?
      - Which hosts were skipped during an agentless scan according to v34.03 host info?
      instructions:
      - text: Get v34.03 host information for hostname {hostname}.
        slots:
          hostname: query.hostname
      - text: Show v34.03 host info for hosts skipped during agentless scans, stopped set to {stopped}.
        slots:
          stopped: query.stopped
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/hosts/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a host scan (v34.03)
      effect: write
      questions:
      - How do I trigger a host scan using the v34.03 API?
      - Can I kick off a fresh host scan on the older v34.03 version?
      instructions:
      - text: Start a host scan using API v34.03.
      - text: Trigger a new v34.03 host scan now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get host scan results (v34.04)
      effect: read
      questions:
      - Which hosts have high severity findings in the v34.04 host scan results?
      - Can I filter v34.04 host scan results by compliance ID?
      instructions:
      - text: Get v34.04 host scan results for hostname {hostname}.
        slots:
          hostname: query.hostname
      - text: List v34.04 host scan results with compliance IDs {complianceIDs}.
        slots:
          complianceIDs: query.complianceIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/hosts/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download host scan results (v34.04)
      effect: read
      questions:
      - Can I download the current v34.04 host scan results as a report?
      - Is it possible to export v34.04 host scans limited to one cluster?
      instructions:
      - text: Download v34.04 host scan results for cluster {clusters}.
        slots:
          clusters: query.clusters
      - text: Export the v34.04 host scan report with issue type {issueType}.
        slots:
          issueType: query.issueType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/hosts/evaluate'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve hosts (v34.04)
      effect: read
      questions:
      - Can I resolve a list of images to hosts with the v34.04 API?
      - What input does the v34.04 host resolve endpoint accept?
      instructions:
      - text: 'Resolve these hosts using the v34.04 evaluate endpoint: {images}.'
        slots:
          images: requestBody.images
      - text: Run v34.04 host resolution on my images.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/hosts/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get host information (v34.04)
      effect: read
      questions:
      - Where do I get host information for agentless-scanned hosts in v34.04?
      - Can v34.04 host info be filtered by uaiID?
      instructions:
      - text: Get v34.04 host information for hosts scanned agentlessly, agentless set to {agentless}.
        slots:
          agentless: query.agentless
      - text: Show v34.04 host info for uaiID {uaiID}.
        slots:
          uaiID: query.uaiID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/hosts/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a host scan (v34.04)
      effect: write
      questions:
      - How do I start a new host scan on the v34.04 API?
      - Can I rescan all hosts right now with version v34.04?
      instructions:
      - text: Start a host scan using API v34.04.
      - text: Kick off a v34.04 host rescan.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Defender-protected host scan results
      effect: read
      questions:
      - What OS vulnerabilities and installed packages were found on hosts protected by Compute Defenders?
      - Can I search Defender-protected hosts by hostname within a collection?
      instructions:
      - text: List Defender host scan results matching hostname search {search}.
        slots:
          search: query.search
      - text: Show Defender-protected host vulnerabilities for collection {collections}.
        slots:
          collections: query.collections
      method: generated
      generated: '2026-09-26'