Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma Cloud Access Keys API Overview Alert Rules API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-alert-rules-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['/v2/alert/rule'].get
$.paths['/alert/rule'].post
$.paths['/alert/rule/{id}'].get
$.paths['/alert/rule/{id}'].put
$.paths['/alert/rule/{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 Prisma Cloud Access Keys API Overview Alert Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-alert-rules-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['/v2/alert/rule'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert rules
      effect: read
      questions:
      - Which Prisma Cloud alert rules can my role see?
      - Can I list only the enabled alert rules?
      instructions:
      - text: List all alert rules.
      - text: List alert rules with enabled set to {enabled}.
        slots:
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert/rule'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert rule
      effect: write
      questions:
      - How do I create an alert rule that scans all policies for a set of accounts?
      - Can a new alert rule notify my third-party tools and auto-remediate?
      - Is it possible to delay notifications from a new alert rule?
      instructions:
      - text: Create alert rule {name} targeting {target} across all policies {scanAll}.
        slots:
          name: requestBody.name
          target: requestBody.target
          scanAll: requestBody.scanAll
      - text: Add alert rule {name} for target {target} scanning policies {policies} with auto-remediation {allowAutoRemediate}.
        slots:
          name: requestBody.name
          target: requestBody.target
          policies: requestBody.policies
          allowAutoRemediate: requestBody.allowAutoRemediate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert/rule/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert rule
      effect: read
      questions:
      - Where do I see the notification configuration of one alert rule?
      - Which policies and targets does a specific alert rule cover?
      instructions:
      - text: Get alert rule {id}.
        slots:
          id: path.id
      - text: Show the notification settings for alert rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert/rule/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an alert rule
      effect: write
      questions:
      - How do I add policies to an existing alert rule?
      - Can I stop an existing alert rule from notifying on dismissed alerts?
      instructions:
      - text: Update alert rule {id} to name {name} with target {target}.
        slots:
          id: path.id
          name: requestBody.name
          target: requestBody.target
      - text: Set notify on resolved to {notifyOnResolved} on existing alert rule {id}.
        slots:
          id: path.id
          notifyOnResolved: requestBody.notifyOnResolved
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert/rule/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert rule
      effect: destructive
      questions:
      - Can I remove an alert rule I no longer use?
      - Can I delete an alert rule by its policy scan config ID?
      instructions:
      - text: Delete alert rule {id}.
        slots:
          id: path.id
      - text: Remove the alert rule with scan config ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'