Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect Infrastructure Settings API

8 actions 8 updates phrasing extends openapi/palo-alto-networks-infrastructure-settings-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 8

$.info
$.paths['/infrastructure-settings'].get
$.paths['/infrastructure-settings'].put
$.paths['/infrastructure-settings'].post
$.paths['/infrastructure-settings'].delete
$.paths['/sse/config/v1/enable'].post
$.paths['/sse/config/v1/shared-infrastructure-settings'].get
$.paths['/sse/config/v1/shared-infrastructure-settings'].put

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 Infrastructure Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-infrastructure-settings-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: 7
- target: $.paths['/infrastructure-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get GlobalProtect infrastructure settings
      effect: read
      questions:
      - What DNS servers and IP pools are set in my GlobalProtect infrastructure settings?
      - How do I look up GlobalProtect infrastructure settings by name?
      instructions:
      - text: Get GlobalProtect infrastructure settings named {name}.
        slots:
          name: query.name
      - text: Show infrastructure setting {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/infrastructure-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update GlobalProtect infrastructure settings
      effect: write
      questions:
      - Can I change the portal hostname in GlobalProtect infrastructure settings?
      - How do I update the IP pools used by GlobalProtect?
      instructions:
      - text: 'Update infrastructure setting {id} ({name}): DNS {dns_servers}, pools {ip_pools}, portal {portal_hostname}.'
        slots:
          id: requestBody.id
          name: requestBody.name
          dns_servers: requestBody.dns_servers
          ip_pools: requestBody.ip_pools
          portal_hostname: requestBody.portal_hostname
      - text: Change the GlobalProtect portal of {name} (id {id}) to {portal_hostname}, keeping DNS {dns_servers} and pools {ip_pools}.
        slots:
          name: requestBody.name
          id: requestBody.id
          portal_hostname: requestBody.portal_hostname
          dns_servers: requestBody.dns_servers
          ip_pools: requestBody.ip_pools
      method: generated
      generated: '2026-09-26'
- target: $.paths['/infrastructure-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create GlobalProtect infrastructure settings
      effect: write
      questions:
      - How do I set up GlobalProtect infrastructure settings for the first time?
      - Can I enable IPv6 when creating GlobalProtect infrastructure?
      instructions:
      - text: Create infrastructure setting {name} (id {id}) with DNS {dns_servers}, pools {ip_pools}, portal {portal_hostname}.
        slots:
          name: requestBody.name
          id: requestBody.id
          dns_servers: requestBody.dns_servers
          ip_pools: requestBody.ip_pools
          portal_hostname: requestBody.portal_hostname
      - text: Set up new GlobalProtect infrastructure {name}, id {id}, portal {portal_hostname}, DNS {dns_servers}, IP pools {ip_pools}.
        slots:
          name: requestBody.name
          id: requestBody.id
          portal_hostname: requestBody.portal_hostname
          dns_servers: requestBody.dns_servers
          ip_pools: requestBody.ip_pools
      method: generated
      generated: '2026-09-26'
- target: $.paths['/infrastructure-settings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete GlobalProtect infrastructure settings
      effect: destructive
      questions:
      - How do I delete a GlobalProtect infrastructure setting?
      - Can I remove GlobalProtect infrastructure settings by name?
      instructions:
      - text: Delete GlobalProtect infrastructure setting {name}.
        slots:
          name: query.name
      - text: Remove infrastructure setting {name} from folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Initialize defaults for a new Prisma Access tenant
      effect: write
      questions:
      - How do I set up application defaults for a newly onboarded Prisma Access tenant?
      - Can I initialize a new tenant without using the cloud-managed UI?
      instructions:
      - text: Set up application defaults for my newly onboarded tenant.
      - text: Initialize the Prisma Access tenant after claiming its license.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/shared-infrastructure-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List shared infrastructure settings
      effect: read
      questions:
      - What infrastructure subnet and BGP AS are configured for Prisma Access?
      - Which egress IP notification URL is set on my shared infrastructure?
      instructions:
      - text: List all shared infrastructure settings.
      - text: Show the infrastructure settings, returning at most {limit}.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/shared-infrastructure-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit shared infrastructure settings
      effect: write
      questions:
      - How do I change the Prisma Access infrastructure subnet?
      - Can I set a URL to be notified when egress IPs change?
      instructions:
      - text: Set the infrastructure subnet to {infrastructure_subnet} with BGP AS {infra_bgp_as}.
        slots:
          infrastructure_subnet: requestBody.infrastructure_subnet
          infra_bgp_as: requestBody.infra_bgp_as
      - text: Update the egress IP notification URL to {egress_ip_notification_url}.
        slots:
          egress_ip_notification_url: requestBody.egress_ip_notification_url
      method: generated
      generated: '2026-10-01'