Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect Application Settings API

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

$.info
$.paths['/agent-profiles'].get
$.paths['/agent-profiles'].put
$.paths['/agent-profiles'].post
$.paths['/agent-profiles'].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 Application Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-application-settings-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: 4
- target: $.paths['/agent-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect agent profiles
      effect: read
      questions:
      - Which GlobalProtect agent profiles are set up for Prisma Access?
      - Can I find a GlobalProtect app profile by name?
      instructions:
      - text: List GlobalProtect agent profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the GlobalProtect agent profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-profiles'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a GlobalProtect agent profile
      effect: write
      questions:
      - How do I change the gateways an existing GlobalProtect agent profile connects to?
      - Can I modify the HIP collection settings on a GlobalProtect app profile that already exists?
      instructions:
      - text: Update GlobalProtect agent profile {name} to use gateways {gateways}.
        slots:
          name: requestBody.name
          gateways: requestBody.gateways
      - text: Change the agent UI settings of existing GlobalProtect profile {name} to {agent_ui}.
        slots:
          name: requestBody.name
          agent_ui: requestBody.agent_ui
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect agent profile
      effect: write
      questions:
      - How do I create a new GlobalProtect app configuration for a group of users?
      - Can a new GlobalProtect agent profile target specific operating systems?
      instructions:
      - text: Create a GlobalProtect agent profile named {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Create new GlobalProtect profile {name} for source users {source_user} on {os}.
        slots:
          name: requestBody.name
          source_user: requestBody.source_user
          os: requestBody.os
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-profiles'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GlobalProtect agent profile
      effect: destructive
      questions:
      - How do I remove a GlobalProtect agent profile by name?
      - Is deleting a GlobalProtect app profile done by name rather than ID?
      instructions:
      - text: Delete GlobalProtect agent profile {name}.
        slots:
          name: query.name
      - text: Remove GlobalProtect agent profile {name} from folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'