Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect Regional and Custom Proxies API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-regional-and-custom-proxies-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 6

$.info
$.paths['/forwarding-profile-regional-and-custom-proxies'].get
$.paths['/forwarding-profile-regional-and-custom-proxies'].post
$.paths['/forwarding-profile-regional-and-custom-proxies/{id}'].get
$.paths['/forwarding-profile-regional-and-custom-proxies/{id}'].put
$.paths['/forwarding-profile-regional-and-custom-proxies/{id}'].delete

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 GlobalProtect Regional and Custom Proxies API
  version: 1.0.0
extends: openapi/palo-alto-networks-regional-and-custom-proxies-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: 5
- target: $.paths['/forwarding-profile-regional-and-custom-proxies'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect regional and custom proxies
      effect: read
      questions:
      - Which regional and custom proxies are configured for GlobalProtect forwarding profiles?
      - Can I page through the GlobalProtect proxies defined in a given folder?
      instructions:
      - text: List the GlobalProtect regional and custom proxies in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the GlobalProtect proxy entries named {name}.
        slots:
          name: query.name
      - text: Show {limit} GlobalProtect regional proxies starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-regional-and-custom-proxies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect regional or custom proxy
      effect: write
      questions:
      - How do I add a custom proxy for GlobalProtect users in Prisma Access?
      - Can I set a fallback option and connectivity preference on a new regional proxy?
      - Which Prisma Access locations can a new regional proxy be tied to?
      instructions:
      - text: Create a GlobalProtect regional proxy named {name} using primary proxy {proxy_1}.
        slots:
          name: requestBody.name
          proxy_1: requestBody.proxy_1
      - text: Add custom proxy {name} in folder {folder} with backup proxy {proxy_2} and fallback {fallback_option}.
        slots:
          name: requestBody.name
          folder: query.folder
          proxy_2: requestBody.proxy_2
          fallback_option: requestBody.fallback_option
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-regional-and-custom-proxies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GlobalProtect regional or custom proxy
      effect: read
      questions:
      - How do I see the full configuration of one GlobalProtect regional proxy?
      - What proxies and locations does a specific custom proxy entry use?
      instructions:
      - text: Show GlobalProtect regional proxy {id}.
        slots:
          id: path.id
      - text: Retrieve the custom proxy configuration with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-regional-and-custom-proxies/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a GlobalProtect regional or custom proxy
      effect: write
      questions:
      - Can I change the proxy servers on an existing GlobalProtect regional proxy?
      - How do I edit the location preference of a custom proxy I already created?
      instructions:
      - text: Update existing GlobalProtect proxy {id} named {name} to use {proxy_1} as its primary proxy.
        slots:
          id: path.id
          name: requestBody.name
          proxy_1: requestBody.proxy_1
      - text: Change the Prisma Access locations on existing custom proxy {id} ({name}) to {prisma_access_locations}.
        slots:
          id: path.id
          name: requestBody.name
          prisma_access_locations: requestBody.prisma_access_locations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forwarding-profile-regional-and-custom-proxies/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GlobalProtect regional or custom proxy
      effect: destructive
      questions:
      - How do I remove a GlobalProtect custom proxy I no longer route through?
      - Can a regional proxy entry be deleted by its UUID?
      instructions:
      - text: Delete GlobalProtect regional proxy {id}.
        slots:
          id: path.id
      - text: Remove the custom proxy entry {id} from the forwarding profiles.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'