Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Deployment Internal DNS Servers API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-internal-dns-servers-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 11

$.info
$.paths['/internal-dns-servers'].get
$.paths['/internal-dns-servers'].post
$.paths['/internal-dns-servers/{id}'].get
$.paths['/internal-dns-servers/{id}'].put
$.paths['/internal-dns-servers/{id}'].delete
$.paths['/sse/config/v1/internal-dns-servers'].get
$.paths['/sse/config/v1/internal-dns-servers'].post
$.paths['/sse/config/v1/internal-dns-servers/{id}'].get
$.paths['/sse/config/v1/internal-dns-servers/{id}'].put
$.paths['/sse/config/v1/internal-dns-servers/{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 Network Deployment Internal DNS Servers API
  version: 1.0.0
extends: openapi/palo-alto-networks-internal-dns-servers-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: 10
- target: $.paths['/internal-dns-servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List internal DNS servers
      effect: read
      questions:
      - Which internal DNS servers are configured for Prisma Access?
      - Can I look up an internal DNS server entry by name?
      instructions:
      - text: List my internal DNS servers.
      - text: Find the internal DNS server named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal-dns-servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an internal DNS server
      effect: write
      questions:
      - How do I resolve internal domains through my own DNS servers in Prisma Access?
      - Can I set a secondary DNS server when adding an internal DNS entry?
      instructions:
      - text: Add internal DNS server {name} for {domains} at primary {primary}, ID {id}.
        slots:
          name: requestBody.name
          domains: requestBody.domain_name
          primary: requestBody.primary
          id: requestBody.id
      - text: Create DNS entry {name} for {domains} with primary {primary} and secondary {secondary}.
        slots:
          name: requestBody.name
          domains: requestBody.domain_name
          primary: requestBody.primary
          secondary: requestBody.secondary
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal-dns-servers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an internal DNS server
      effect: read
      questions:
      - Where can I see one internal DNS server's settings?
      - What primary and secondary IPs does an internal DNS server use?
      instructions:
      - text: Get internal DNS server {id}.
        slots:
          id: path.id
      - text: Show the domains and IPs of internal DNS server {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal-dns-servers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an internal DNS server
      effect: write
      questions:
      - How do I change the primary IP of an existing internal DNS server?
      - Can I add more domains to an internal DNS server entry?
      instructions:
      - text: Point internal DNS server {id} at primary {primary}.
        slots:
          id: path.id
          primary: requestBody.primary
      - text: Update internal DNS server {id} to serve domains {domains}.
        slots:
          id: path.id
          domains: requestBody.domain_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal-dns-servers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an internal DNS server
      effect: destructive
      questions:
      - Can I remove an internal DNS server entry?
      - What happens to internal name resolution if I delete a DNS server entry?
      instructions:
      - text: Delete internal DNS server {id}.
        slots:
          id: path.id
      - text: Remove the internal DNS server entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/internal-dns-servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List internal DNS servers in a folder
      effect: read
      questions:
      - Which internal DNS servers resolve my private domains in Prisma Access?
      - Can I look up an internal DNS server by name within a specific folder?
      instructions:
      - text: List internal DNS servers in folder {folder}.
        slots:
          folder: query.folder
      - text: Find internal DNS server {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/internal-dns-servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an internal DNS server
      effect: write
      questions:
      - How do I send lookups for my internal domains to our own DNS server?
      - Can I set a secondary internal DNS server for failover?
      instructions:
      - text: Add internal DNS server {name} in {folder} for domains {domain_name} using primary {primary}.
        slots:
          name: requestBody.name
          folder: query.folder
          domain_name: requestBody.domain_name
          primary: requestBody.primary
      - text: Create DNS server {name} in {folder} for {domain_name}, primary {primary}, secondary {secondary}.
        slots:
          name: requestBody.name
          folder: query.folder
          domain_name: requestBody.domain_name
          primary: requestBody.primary
          secondary: requestBody.secondary
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/internal-dns-servers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an internal DNS server
      effect: read
      questions:
      - Which domains and IPs does a specific internal DNS server entry use?
      - How do I fetch one internal DNS server by ID?
      instructions:
      - text: Show internal DNS server {id}.
        slots:
          id: path.id
      - text: Get the primary and secondary addresses of DNS server {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/internal-dns-servers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an internal DNS server
      effect: write
      questions:
      - Via the SSE config v1 path, how do I edit an internal DNS server's primary IP?
      - Can I update which domains an internal DNS server handles?
      instructions:
      - text: Update DNS server {id} named {name} to serve {domain_name} from primary {primary}.
        slots:
          id: path.id
          name: requestBody.name
          domain_name: requestBody.domain_name
          primary: requestBody.primary
      - text: Edit DNS server {id} ({name}, {domain_name}, {primary}) and set secondary to {secondary}.
        slots:
          id: path.id
          name: requestBody.name
          domain_name: requestBody.domain_name
          primary: requestBody.primary
          secondary: requestBody.secondary
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/internal-dns-servers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an internal DNS server
      effect: destructive
      questions:
      - How do I remove an internal DNS server entry?
      - Can I delete an internal DNS server by its ID?
      instructions:
      - text: Delete internal DNS server {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the internal DNS entry with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'