Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma AIRS API Management service API key API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-api-key-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['/v1/mgmt/apikey'].post

$.paths['/v1/mgmt/apikeys'].get

$.paths['/v1/mgmt/apikey/delete/{api_key_name}'].delete

$.paths['/v1/mgmt/apikey/regenerate/{api_key_id}'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Prisma AIRS API Management service API key API
  version: 1.0.0
extends: openapi/palo-alto-networks-api-key-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['/v1/mgmt/apikey'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key for an AI app
      effect: write
      questions:
      - How do I issue a new API key tied to a deployment profile's auth code?
      - Can I set an automatic rotation interval when creating an API key?
      instructions:
      - text: Create API key {api_key_name} for app {cust_app}, auth code {auth_code}, rotating every {rotation_time_interval} {rotation_time_unit}.
        slots:
          api_key_name: requestBody.api_key_name
          cust_app: requestBody.cust_app
          auth_code: requestBody.auth_code
          rotation_time_interval: requestBody.rotation_time_interval
          rotation_time_unit: requestBody.rotation_time_unit
      - text: Issue key {api_key_name} for {cust_app} on {cust_cloud_provider} using auth code {auth_code}.
        slots:
          api_key_name: requestBody.api_key_name
          cust_app: requestBody.cust_app
          cust_cloud_provider: requestBody.cust_cloud_provider
          auth_code: requestBody.auth_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/apikeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List API keys for my tenant
      effect: read
      questions:
      - Which API keys exist for my tenant service group and when do they rotate?
      - Can I page through all API key metadata?
      instructions:
      - text: List all API keys for my TSG.
      - text: List API keys starting at offset {offset}, {limit} per page.
        slots:
          offset: query.offset
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/apikey/delete/{api_key_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key and its app
      effect: destructive
      questions:
      - Can I permanently delete an API key along with the customer app attached to it?
      - Does removing an API key also remove its associated app?
      instructions:
      - text: Delete API key {api_key_name}, recorded as updated by {updated_by}.
        slots:
          api_key_name: path.api_key_name
          updated_by: query.updated_by
      - text: Remove key {api_key_name} and its customer app on behalf of {updated_by}.
        slots:
          api_key_name: path.api_key_name
          updated_by: query.updated_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mgmt/apikey/regenerate/{api_key_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate an API key
      effect: write
      questions:
      - How do I rotate an API key and get a fresh secret?
      - Can I change the rotation schedule when regenerating a key?
      instructions:
      - text: Regenerate API key {api_key_id} with rotation every {rotation_time_interval} {rotation_time_unit}.
        slots:
          api_key_id: path.api_key_id
          rotation_time_interval: requestBody.rotation_time_interval
          rotation_time_unit: requestBody.rotation_time_unit
      - text: Rotate key {api_key_id} now, set rotation to {rotation_time_interval} {rotation_time_unit}, by {updated_by}.
        slots:
          api_key_id: path.api_key_id
          rotation_time_interval: requestBody.rotation_time_interval
          rotation_time_unit: requestBody.rotation_time_unit
          updated_by: requestBody.updated_by
      method: generated
      generated: '2026-09-26'