Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Objects Auto-Tag Actions API

9 actions 9 updates phrasing extends openapi/palo-alto-networks-auto-tag-actions-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 9

$.info
$.paths['/auto-tag-actions'].get
$.paths['/auto-tag-actions'].put
$.paths['/auto-tag-actions'].post
$.paths['/auto-tag-actions'].delete
$.paths['/sse/config/v1/auto-tag-actions'].get
$.paths['/sse/config/v1/auto-tag-actions'].put
$.paths['/sse/config/v1/auto-tag-actions'].post
$.paths['/sse/config/v1/auto-tag-actions'].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 Objects Auto-Tag Actions API
  version: 1.0.0
extends: openapi/palo-alto-networks-auto-tag-actions-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: 8
- target: $.paths['/auto-tag-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List auto-tag actions
      effect: read
      questions:
      - Which auto-tag actions are configured to tag hosts based on log events?
      - Can I look up an auto-tag action by its name?
      instructions:
      - text: List all auto-tag actions.
      - text: Find the auto-tag action named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auto-tag-actions'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an auto-tag action
      effect: write
      questions:
      - Can I change the log filter on an existing auto-tag action?
      - How do I turn on quarantine for an auto-tag action I already have?
      instructions:
      - text: Update auto-tag action {name} for {log_type} logs to use filter {filter}.
        slots:
          name: requestBody.name
          log_type: requestBody.log_type
          filter: requestBody.filter
      - text: Change existing auto-tag action {name} ({log_type}, filter {filter}) to quarantine {quarantine}.
        slots:
          name: requestBody.name
          log_type: requestBody.log_type
          filter: requestBody.filter
          quarantine: requestBody.quarantine
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auto-tag-actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an auto-tag action
      effect: write
      questions:
      - How do I automatically tag an IP when a matching log entry appears?
      - Can a new auto-tag action also send tags to Panorama?
      instructions:
      - text: Create auto-tag action {name} on {log_type} logs matching {filter} with actions {actions}.
        slots:
          name: requestBody.name
          log_type: requestBody.log_type
          filter: requestBody.filter
          actions: requestBody.actions
      - text: Add a new auto-tag action {name} for {log_type} logs with filter {filter} and send-to-Panorama {send_to_panorama}.
        slots:
          name: requestBody.name
          log_type: requestBody.log_type
          filter: requestBody.filter
          send_to_panorama: requestBody.send_to_panorama
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auto-tag-actions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an auto-tag action
      effect: destructive
      questions:
      - How do I stop an auto-tag action from tagging anything by removing it?
      - Do I delete an auto-tag action by name rather than ID?
      instructions:
      - text: Delete the auto-tag action named {name}.
        slots:
          name: query.name
      - text: Remove auto-tag action {name} permanently.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/auto-tag-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List auto tag actions
      effect: read
      questions:
      - Which auto tag actions are configured to tag sources from log matches?
      - Through the SSE config v1 path, can I look up an auto tag action by name?
      instructions:
      - text: List my auto tag actions.
      - text: Find auto tag action {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/auto-tag-actions'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an auto tag action
      effect: write
      questions:
      - Via the SSE config v1 path, can I change the log filter of an auto tag action?
      - Using the SSE config v1 path, how do I enable quarantine on an auto tag action?
      instructions:
      - text: Edit auto tag action {name} to match filter {filter} on {log_type} logs.
        slots:
          name: requestBody.name
          filter: requestBody.filter
          log_type: requestBody.log_type
      - text: Update existing auto tag action {name} ({log_type}, filter {filter}) to quarantine {quarantine}.
        slots:
          name: requestBody.name
          log_type: requestBody.log_type
          filter: requestBody.filter
          quarantine: requestBody.quarantine
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/auto-tag-actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an auto tag action
      effect: write
      questions:
      - How do I automatically tag an IP when a log entry matches a filter?
      - Can a new auto tag action forward its matches to Panorama?
      instructions:
      - text: Create auto tag action {name} for {log_type} logs matching {filter}.
        slots:
          name: requestBody.name
          log_type: requestBody.log_type
          filter: requestBody.filter
      - text: Create new auto tag action {name} on {log_type} logs, filter {filter}, running actions {actions}.
        slots:
          name: requestBody.name
          log_type: requestBody.log_type
          filter: requestBody.filter
          actions: requestBody.actions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/auto-tag-actions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an auto tag action
      effect: destructive
      questions:
      - How do I stop an auto tag action from tagging anything?
      - Can I delete an auto tag action by name?
      instructions:
      - text: Delete auto tag action {name}.
        slots:
          name: query.name
      - text: Remove the auto tag action called {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'