Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Cloud API

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

$.info
$.paths['/api/v34.03/cloud/discovery'].get
$.paths['/api/v34.03/cloud/discovery/download'].get
$.paths['/api/v34.03/cloud/discovery/entities'].get
$.paths['/api/v34.03/cloud/discovery/scan'].post
$.paths['/api/v34.03/cloud/discovery/stop'].post
$.paths['/api/v34.03/cloud/discovery/vms'].get
$.paths['/api/v34.04/cloud/discovery'].get
$.paths['/api/v34.04/cloud/discovery/download'].get
$.paths['/api/v34.04/cloud/discovery/entities'].get
$.paths['/api/v34.04/cloud/discovery/scan'].post
$.paths['/api/v34.04/cloud/discovery/stop'].post
$.paths['/api/v34.04/cloud/discovery/vms'].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 Cloud API
  version: 1.0.0
extends: openapi/palo-alto-networks-cloud-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: 12
- target: $.paths['/api/v34.03/cloud/discovery'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cloud discovery scan results (v34.03)
      effect: read
      questions:
      - What did the last cloud discovery scan find, according to the v34.03 API?
      - Can I filter v34.03 discovery results to agentless-covered accounts?
      instructions:
      - text: Using v34.03, get cloud discovery results for provider {provider}.
        slots:
          provider: query.provider
      - text: On API v34.03, show discovery results for account name {accountName}.
        slots:
          accountName: query.accountName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/cloud/discovery/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Export cloud discovery results (v34.03)
      effect: read
      questions:
      - Can I download cloud discovery scan results as a file with version v34.03?
      - Does the v34.03 discovery export support filtering by service type?
      instructions:
      - text: Download v34.03 cloud discovery results for service type {serviceType}.
        slots:
          serviceType: query.serviceType
      - text: Export all cloud discovery findings to a file via API v34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/cloud/discovery/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List discovered cloud entities (v34.03)
      effect: read
      questions:
      - Which discovered cloud entities are undefended, per the v34.03 API?
      - Can I look up v34.03 discovered entities by container image digest?
      instructions:
      - text: With v34.03, list discovered cloud entities where defended is {defended}.
        slots:
          defended: query.defended
      - text: On API v34.03, show discovered entities running image {images}.
        slots:
          images: query.images
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/cloud/discovery/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a cloud discovery scan (v34.03)
      effect: write
      questions:
      - How do I kick off a cloud discovery scan through the v34.03 API?
      - Can I run cloud discovery on demand with version v34.03?
      instructions:
      - text: Start a cloud discovery scan using the v34.03 endpoint.
      - text: Launch cloud account discovery now via API v34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/cloud/discovery/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running cloud discovery scan (v34.03)
      effect: destructive
      questions:
      - How do I cancel a cloud discovery scan that is running, on v34.03?
      - Can the v34.03 API halt discovery midway?
      instructions:
      - text: Stop the running cloud discovery scan via v34.03.
      - text: Cancel cloud discovery in progress using API version v34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/cloud/discovery/vms'].get
  update:
    x-apievangelist-phrasing:
      intent: List discovered VMs (v34.03)
      effect: read
      questions:
      - Which discovered virtual machines lack a Defender, per the v34.03 API?
      - Can I list v34.03 discovered VMs for a single region?
      instructions:
      - text: With v34.03, list discovered VMs in region {region}.
        slots:
          region: query.region
      - text: On API v34.03, show discovered VMs where hasDefender is {hasDefender}.
        slots:
          hasDefender: query.hasDefender
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/cloud/discovery'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cloud discovery scan results
      effect: read
      questions:
      - Which cloud services and registries did discovery find in my accounts?
      - Can I see discovery results for one credential only?
      instructions:
      - text: Get cloud discovery results for credential {credentialID}.
        slots:
          credentialID: query.credentialID
      - text: Show discovery results in zone {zone}.
        slots:
          zone: query.zone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/cloud/discovery/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download cloud discovery scan results
      effect: read
      questions:
      - How do I download a CSV of cloud discovery results in Prisma Cloud Compute?
      - Can the discovery CSV be limited to one registry?
      instructions:
      - text: Download a CSV of cloud discovery results for registry {registry}.
        slots:
          registry: query.registry
      - text: Get cloud discovery results as a CSV for provider {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/cloud/discovery/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List discovered cloud entities
      effect: read
      questions:
      - What functions, clusters and registries has cloud discovery found?
      - Which discovered cloud entities belong to one credential?
      instructions:
      - text: List discovered cloud entities for credential {credentialID}.
        slots:
          credentialID: query.credentialID
      - text: Show discovered entities with image digest {imageDigests}.
        slots:
          imageDigests: query.imageDigests
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/cloud/discovery/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a cloud discovery scan
      effect: write
      questions:
      - How can I scan my cloud accounts for unprotected services right now?
      - Is there a way to trigger cloud discovery without waiting for the schedule?
      instructions:
      - text: Run a cloud discovery scan now.
      - text: Start discovering cloud resources across my accounts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/cloud/discovery/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running cloud discovery scan
      effect: destructive
      questions:
      - How do I stop a cloud discovery scan that is taking too long?
      - Can I abort discovery that is currently in progress?
      instructions:
      - text: Stop the cloud discovery scan that is running.
      - text: Abort the current cloud discovery.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/cloud/discovery/vms'].get
  update:
    x-apievangelist-phrasing:
      intent: List discovered virtual machines
      effect: read
      questions:
      - Which VMs did cloud discovery find, and do they have a Defender installed?
      - Can I list discovered virtual machines from one cloud provider?
      instructions:
      - text: List discovered VMs from provider {provider}.
        slots:
          provider: query.provider
      - text: Show discovered virtual machines with no Defender, hasDefender {hasDefender}.
        slots:
          hasDefender: query.hasDefender
      method: generated
      generated: '2026-09-26'