Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Remote Networks API

18 actions 18 updates phrasing extends openapi/palo-alto-networks-remote-networks-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/remote-networks'].get
$.paths['/v1/remote-networks'].put
$.paths['/v1/remote-networks'].post
$.paths['/v1/remote-networks'].delete
$.paths['/v1/remote-networks-read'].get
$.paths['/v1/remote-networks-read'].post
$.paths['/remote-networks'].get
$.paths['/remote-networks'].post
$.paths['/remote-networks/{id}'].get
$.paths['/remote-networks/{id}'].put
$.paths['/remote-networks/{id}'].delete
$.paths['/remote-networks/{id}/refresh-ike-gateway'].post
$.paths['/sse/config/v1/remote-networks'].get
$.paths['/sse/config/v1/remote-networks'].post
$.paths['/sse/config/v1/remote-networks/{id}'].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 Remote Networks API
  version: 1.0.0
extends: openapi/palo-alto-networks-remote-networks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/v1/remote-networks'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a remote network tunnel job's status
      effect: read
      questions:
      - How do I check whether my bulk IPSec tunnel create, modify or delete finished?
      - What happened to the remote networks tunnel request I submitted?
      instructions:
      - text: Get the IPSec tunnel job details for request {id}.
        slots:
          id: query.id
      - text: Check the status of bulk tunnel change request {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/remote-networks'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk modify remote network IPSec tunnels
      effect: write
      questions:
      - Can I modify many remote network IPSec tunnels in one request?
      - Can I change tunnels for just one sub-tenant in a Panorama multi-tenant setup?
      instructions:
      - text: Modify the remote network IPSec tunnels with suffix {name}.
        slots:
          name: requestBody.name
      - text: Bulk update tunnels {remote_networks_ipsec_tunnels} under suffix {name} for sub-tenant {SubTenantName}.
        slots:
          name: requestBody.name
          remote_networks_ipsec_tunnels: requestBody.remote_networks_ipsec_tunnels
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/remote-networks'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create remote network IPSec tunnels
      effect: write
      questions:
      - How do I create a batch of new IPSec tunnels for my branch sites?
      - Can I bulk-provision remote network tunnels for a Panorama sub-tenant?
      instructions:
      - text: Create remote network IPSec tunnels {remote_networks_ipsec_tunnels} with name suffix {name}.
        slots:
          name: requestBody.name
          remote_networks_ipsec_tunnels: requestBody.remote_networks_ipsec_tunnels
      - text: Bulk create new branch tunnels named {name} for sub-tenant {SubTenantName}.
        slots:
          name: requestBody.name
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/remote-networks'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete remote network IPSec tunnels
      effect: destructive
      questions:
      - Can I remove a whole set of IPSec tunnels sharing a prefix?
      - Can I bulk delete remote networks for just one sub-tenant?
      instructions:
      - text: Delete all remote network tunnels with prefix {remote_networks_prefix}.
        slots:
          remote_networks_prefix: query.remote_networks_prefix
      - text: Bulk remove tunnels {Name} under prefix {remote_networks_prefix}.
        slots:
          remote_networks_prefix: query.remote_networks_prefix
          Name: query.Name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/remote-networks-read'].get
  update:
    x-apievangelist-phrasing:
      intent: Read IPSec tunnel status results
      effect: read
      questions:
      - Where do I pick up the tunnel status results from a read request I queued?
      - Where do I see the current state of IPSec tunnels by request UUID?
      instructions:
      - text: Read the IPSec tunnel status for read request {id}.
        slots:
          id: query.id
      - text: Fetch the tunnel status results queued under {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/remote-networks-read'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a read of IPSec tunnels
      effect: read
      questions:
      - Can I ask for the status of specific remote network tunnels?
      - Can I queue a status read for a list of remote network names?
      instructions:
      - text: Request a status read for remote networks {remote_networks_names}.
        slots:
          remote_networks_names: requestBody.remote_networks_names
      - text: Queue a tunnel read for sub-tenant {SubTenantName}.
        slots:
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/remote-networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List Prisma Access remote networks
      effect: read
      questions:
      - Which branch and data center sites are connected to Prisma Access as remote networks?
      - Can I list Prisma Access remote networks without naming a folder?
      instructions:
      - text: List all Prisma Access remote networks in the tenant.
      - text: Show Prisma Access remote networks in location {location} with status {status}.
        slots:
          location: query.location
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/remote-networks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Prisma Access remote network
      effect: write
      questions:
      - How do I connect a new branch office to Prisma Access as a remote network?
      - Do I need to push the config after creating a Prisma Access remote network?
      instructions:
      - text: Create Prisma Access remote network {name} in location {location} with subnets {subnets} over IKE gateway {ike_gateway}.
        slots:
          name: requestBody.name
          location: requestBody.location
          subnets: requestBody.subnets
          ike_gateway: requestBody.ike_gateway
      - text: Add a Prisma Access branch site {name} at {location}, local subnets {subnets}, gateway {ike_gateway}, capped at {bandwidth_mbps} Mbps.
        slots:
          name: requestBody.name
          location: requestBody.location
          subnets: requestBody.subnets
          ike_gateway: requestBody.ike_gateway
          bandwidth_mbps: requestBody.bandwidth_mbps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/remote-networks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a remote network's tunnel configuration
      effect: read
      questions:
      - What IKE gateway and subnets are configured for one branch tunnel?
      - Where can I view the full config of a single remote network?
      instructions:
      - text: Get remote network {id}.
        slots:
          id: path.id
      - text: Show the tunnel configuration of branch network {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/remote-networks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Prisma Access remote network
      effect: write
      questions:
      - How do I change the compute region of a Prisma Access remote network in the candidate config?
      - Can I update the local subnets for an existing Prisma Access branch site?
      instructions:
      - text: Update Prisma Access remote network {id} with name {name} and location {location}.
        slots:
          id: path.id
          name: requestBody.name
          location: requestBody.location
      - text: Change Prisma Access site {id} ({name}, {location}) to subnets {subnets} on IKE gateway {ike_gateway}.
        slots:
          id: path.id
          name: requestBody.name
          location: requestBody.location
          subnets: requestBody.subnets
          ike_gateway: requestBody.ike_gateway
      method: generated
      generated: '2026-10-01'
- target: $.paths['/remote-networks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote network and tear down its tunnel
      effect: destructive
      questions:
      - What happens to the IPsec tunnel when I delete a single remote network?
      - Can I decommission one branch office connection?
      instructions:
      - text: Delete remote network {id}.
        slots:
          id: path.id
      - text: Tear down the tunnel for branch network {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/remote-networks/{id}/refresh-ike-gateway'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a remote network's IKE gateway
      effect: write
      questions:
      - How do I re-establish a failed branch IPsec tunnel?
      - Do I need to refresh the IKE gateway after changing IKE parameters?
      instructions:
      - text: Refresh the IKE gateway for remote network {id}.
        slots:
          id: path.id
      - text: Re-establish the failed tunnel on branch {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/remote-networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote networks in a folder (SSE config)
      effect: read
      questions:
      - Which remote networks are configured in a given folder of the SSE config API?
      - Can I page through SSE remote networks in a folder with a limit and offset?
      instructions:
      - text: List SSE config remote networks in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the SSE remote network named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/remote-networks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a remote network via SSE config
      effect: write
      questions:
      - How do I create a remote network with ECMP tunnels through the SSE config endpoint?
      - What license type and region does a new SSE remote network require?
      instructions:
      - text: Create SSE remote network {name} in folder {folder}, region {region}, license {license_type}.
        slots:
          name: requestBody.name
          folder: query.folder
          region: requestBody.region
          license_type: requestBody.license_type
      - text: Add SSE remote network {name} in {folder} ({region}, {license_type}) using IPSec tunnel {ipsec_tunnel}.
        slots:
          name: requestBody.name
          folder: query.folder
          region: requestBody.region
          license_type: requestBody.license_type
          ipsec_tunnel: requestBody.ipsec_tunnel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/remote-networks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a remote network by ID (SSE config)
      effect: read
      questions:
      - What is the configuration of one remote network in the SSE config API?
      - Can I fetch an SSE remote network's tunnels and subnets by its UUID?
      instructions:
      - text: Get SSE config remote network {id}.
        slots:
          id: path.id
      - text: Show the tunnels and subnets of SSE remote network {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/remote-networks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a remote network (SSE config)
      effect: write
      questions:
      - How do I change the subnets or secondary tunnel on an SSE remote network?
      - Can I turn on ECMP load balancing for an existing SSE remote network?
      instructions:
      - text: 'Edit SSE remote network {id}: name {name}, region {region}, license {license_type}, subnets {subnets}.'
        slots:
          id: path.id
          name: requestBody.name
          region: requestBody.region
          license_type: requestBody.license_type
          subnets: requestBody.subnets
      - text: Set secondary IPSec tunnel {secondary_ipsec_tunnel} on SSE remote network {id} ({name}, {region}, {license_type}).
        slots:
          secondary_ipsec_tunnel: requestBody.secondary_ipsec_tunnel
          id: path.id
          name: requestBody.name
          region: requestBody.region
          license_type: requestBody.license_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/remote-networks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote network (SSE config)
      effect: destructive
      questions:
      - How do I delete a remote network through the SSE config API?
      - Can I remove an SSE remote network by its UUID?
      instructions:
      - text: Delete SSE config remote network {id}.
        slots:
          id: path.id
      - text: Remove SSE remote network {id} from the configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'