Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Profiles API

23 actions 23 updates phrasing extends openapi/palo-alto-networks-profiles-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 23 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v34.03/profiles/app-embedded'].get
$.paths['/api/v34.03/profiles/app-embedded/download'].get
$.paths['/api/v34.03/profiles/container'].get
$.paths['/api/v34.03/profiles/container/download'].get
$.paths['/api/v34.03/profiles/container/learn'].post
$.paths['/api/v34.03/profiles/host'].get
$.paths['/api/v34.03/profiles/host/download'].get
$.paths['/api/v34.04/profiles/app-embedded'].get
$.paths['/api/v34.04/profiles/app-embedded/download'].get
$.paths['/api/v34.04/profiles/container'].get
$.paths['/api/v34.04/profiles/container/download'].get
$.paths['/api/v34.04/profiles/container/learn'].post
$.paths['/api/v34.04/profiles/host'].get
$.paths['/api/v34.04/profiles/host/download'].get
$.paths['/v1/profile'].get

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 Palo Alto Networks Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-profiles-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: 22
- target: $.paths['/api/v34.03/profiles/app-embedded'].get
  update:
    x-apievangelist-phrasing:
      intent: List app-embedded runtime profiles (v34.03)
      effect: read
      questions:
      - Which app-embedded Defender runtime profiles exist on the older v34.03 Compute API?
      - Can I filter v34.03 app-embedded profiles by app ID or container image?
      instructions:
      - text: Using the v34.03 endpoint, list app-embedded profiles for app ID {appID}.
        slots:
          appID: query.appID
      - text: On API v34.03, show app-embedded runtime profiles in cluster {cluster}.
        slots:
          cluster: query.cluster
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/profiles/app-embedded/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Export app-embedded profiles as CSV (v34.03)
      effect: read
      questions:
      - Can I export app-embedded runtime profiles to a file with the v34.03 API?
      - Is there a v34.03 download of app-embedded profiles filtered by image?
      instructions:
      - text: Download the v34.03 app-embedded profile report for image {image}.
        slots:
          image: query.image
      - text: Export every app-embedded profile to a file via API version v34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/profiles/container'].get
  update:
    x-apievangelist-phrasing:
      intent: List runtime container profiles (v34.03)
      effect: read
      questions:
      - What runtime models has Defender learned for my containers, per the v34.03 API?
      - Can the v34.03 container profile list be narrowed to one Kubernetes namespace?
      instructions:
      - text: With v34.03, list runtime container profiles in namespace {namespace}.
        slots:
          namespace: query.namespace
      - text: On the v34.03 API, fetch container runtime profiles for host {hostName}.
        slots:
          hostName: query.hostName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/profiles/container/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Export runtime container profiles (v34.03)
      effect: read
      questions:
      - Can I get container runtime profiles as a downloadable file from API v34.03?
      - Does the v34.03 container profile export honour the cluster filter?
      instructions:
      - text: Download v34.03 container runtime profiles for cluster {cluster}.
        slots:
          cluster: query.cluster
      - text: Export all container runtime models to a file using v34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/profiles/container/learn'].post
  update:
    x-apievangelist-phrasing:
      intent: Relearn container runtime profiles (v34.03)
      effect: write
      questions:
      - How do I make Defender relearn container runtime models on the v34.03 API?
      - Can I restart runtime learning for containers through version v34.03?
      instructions:
      - text: Trigger container runtime profile learning via the v34.03 endpoint.
      - text: Restart learning of container models using API v34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/profiles/host'].get
  update:
    x-apievangelist-phrasing:
      intent: List runtime host profiles (v34.03)
      effect: read
      questions:
      - What runtime host profiles are recorded for my hosts in the v34.03 API?
      - Can I filter v34.03 host runtime profiles by operating system?
      instructions:
      - text: Using v34.03, list host runtime profiles for hostname {hostName}.
        slots:
          hostName: query.hostName
      - text: On API v34.03, show host runtime profiles running OS {os}.
        slots:
          os: query.os
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/profiles/host/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Export runtime host profiles (v34.03)
      effect: read
      questions:
      - Is there a v34.03 way to download host runtime profiles as a file?
      - Can I export only host profiles in a given state with version v34.03?
      instructions:
      - text: Download v34.03 host runtime profiles in state {state}.
        slots:
          state: query.state
      - text: Export every host runtime profile to a file through v34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/profiles/app-embedded'].get
  update:
    x-apievangelist-phrasing:
      intent: List app-embedded runtime profiles
      effect: read
      questions:
      - What app-embedded Defender profiles are protecting my serverless and Fargate apps?
      - Can I look up app-embedded profiles for a specific image ID?
      instructions:
      - text: List app-embedded profiles for container {container}.
        slots:
          container: query.container
      - text: Show app-embedded profiles for image ID {imageID}, newest first.
        slots:
          imageID: query.imageID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/profiles/app-embedded/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download app-embedded runtime profiles
      effect: read
      questions:
      - How do I download a CSV of app-embedded profiles in Prisma Cloud Compute?
      - Can the app-embedded profile download be limited to one cluster?
      instructions:
      - text: Download app-embedded profiles for cluster {cluster} as a CSV.
        slots:
          cluster: query.cluster
      - text: Give me a CSV file of all app-embedded profiles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/profiles/container'].get
  update:
    x-apievangelist-phrasing:
      intent: List runtime container profiles
      effect: read
      questions:
      - Which processes and network activity has Defender modelled for my containers?
      - Can I see container runtime profiles only for a specific image?
      instructions:
      - text: List container runtime profiles for image {image}.
        slots:
          image: query.image
      - text: Show container runtime models in Kubernetes cluster {cluster}.
        slots:
          cluster: query.cluster
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/profiles/container/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download runtime container profiles
      effect: read
      questions:
      - Can I pull a CSV of every container runtime model for an audit?
      - Does the container profile CSV support filtering by namespace?
      instructions:
      - text: Download a CSV of container runtime profiles in namespace {namespace}.
        slots:
          namespace: query.namespace
      - text: Get a CSV export of container runtime profiles for image ID {imageID}.
        slots:
          imageID: query.imageID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/profiles/container/learn'].post
  update:
    x-apievangelist-phrasing:
      intent: Relearn runtime container profiles
      effect: write
      questions:
      - How can I force Defender to re-learn container behaviour after a deployment?
      - Is it possible to reset runtime model learning for all containers?
      instructions:
      - text: Start relearning runtime models for my containers.
      - text: Kick off container runtime profile learning again.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/profiles/host'].get
  update:
    x-apievangelist-phrasing:
      intent: List runtime host profiles
      effect: read
      questions:
      - What has Defender learned about normal behaviour on my hosts?
      - Can I list host runtime models only for hosts in one state?
      instructions:
      - text: List host runtime profiles in state {state}.
        slots:
          state: query.state
      - text: Show the runtime model for host {hostName}.
        slots:
          hostName: query.hostName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/profiles/host/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download runtime host profiles
      effect: read
      questions:
      - Can I download host runtime models as a CSV for offline review?
      - Where do I get a file of host profiles filtered by OS?
      instructions:
      - text: Download a CSV of host runtime profiles for OS {os}.
        slots:
          os: query.os
      - text: Get a CSV of host runtime profiles sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI security profiles
      effect: read
      questions:
      - Which AI security profiles are configured for my AI Runtime Security tenant?
      - What detection categories and enforcement actions do my AI profiles use?
      instructions:
      - text: List all AI security profiles in my tenant.
      - text: Show the first {limit} AI security profiles.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/profile/{profile_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI security profile's settings
      effect: read
      questions:
      - What sensitivity thresholds are set on a specific AI security profile?
      - Is prompt injection detection enabled in one of my named AI profiles?
      instructions:
      - text: Show the full configuration of AI security profile {profile_name}.
        slots:
          profile_name: path.profile_name
      - text: Get the enforcement actions set in AI profile {profile_name}.
        slots:
          profile_name: path.profile_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS resolver profiles
      effect: read
      questions:
      - Which DNS resolver profiles have I set up for Advanced DNS?
      - Can I search my DNS profiles by name or description?
      instructions:
      - text: List DNS resolver profiles matching {search}.
        slots:
          search: query.search
      - text: Show all DNS profiles sorted by {sort_by}.
        slots:
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DNS resolver profile
      effect: write
      questions:
      - How do I create a DNS filtering profile with SafeSearch turned on?
      - Can a new DNS profile enforce YouTube restricted mode?
      instructions:
      - text: Create a DNS profile named {name}.
        slots:
          name: requestBody.name
      - text: Create DNS profile {name} with SafeSearch set to {safesearch_enabled}.
        slots:
          name: requestBody.name
          safesearch_enabled: requestBody.safesearch_enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/profiles/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List DNS profile categories
      effect: read
      questions:
      - What content categories can I override in a DNS profile?
      - Which category names are available for DNS profile overrides?
      instructions:
      - text: List the available DNS profile categories.
      - text: Show every category I can block or allow in a DNS profile.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/profiles/{profile-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DNS resolver profile
      effect: read
      questions:
      - What overrides are configured on one particular DNS profile?
      - Can I check whether a given DNS profile has SafeSearch enabled?
      instructions:
      - text: Get DNS profile {profile-id}.
        slots:
          profile-id: path.profile-id
      - text: Show the category and FQDN overrides on DNS profile {profile-id}.
        slots:
          profile-id: path.profile-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/profiles/{profile-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS resolver profile
      effect: write
      questions:
      - How do I change the overrides on an existing DNS profile?
      - Can I switch YouTube restricted mode to strict on a DNS profile I already have?
      instructions:
      - text: Rename DNS profile {profile-id} to {name}.
        slots:
          profile-id: path.profile-id
          name: requestBody.name
      - text: Set YouTube restricted mode to {youtube_restricted_mode} on DNS profile {profile-id}.
        slots:
          youtube_restricted_mode: requestBody.youtube_restricted_mode
          profile-id: path.profile-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adns-resolver/v1/profiles/{profile-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DNS resolver profile
      effect: destructive
      questions:
      - How do I remove a DNS profile I no longer use?
      - What happens if I delete a DNS resolver profile?
      instructions:
      - text: Delete DNS profile {profile-id}.
        slots:
          profile-id: path.profile-id
      - text: Remove the DNS resolver profile with ID {profile-id}.
        slots:
          profile-id: path.profile-id
      method: generated
      generated: '2026-09-26'