Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HTTPS Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-httpsprofiles-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['/logging-service/logforwarding/v1/https-profiles'].get

$.paths['/logging-service/logforwarding/v1/https-profiles'].post

$.paths['/logging-service/logforwarding/v1/https-profiles/{profileId}'].get

$.paths['/logging-service/logforwarding/v1/https-profiles/{profileId}'].put

$.paths['/logging-service/logforwarding/v1/https-profiles/{profileId}'].delete

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 HTTPS Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-httpsprofiles-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['/logging-service/logforwarding/v1/https-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List log forwarding HTTPS profiles
      effect: read
      questions:
      - Which HTTPS profiles are set up to forward Cortex Data Lake logs to my SIEM?
      - Can I list only the log forwarding profiles with a particular status?
      - Where do I find the profile IDs of all my HTTPS log forwarding destinations?
      instructions:
      - text: List all my HTTPS log forwarding profiles.
      - text: Show up to {resultSize} HTTPS forwarding profiles with status {status}.
        slots:
          resultSize: query.resultSize
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/https-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an HTTPS log forwarding profile
      effect: write
      questions:
      - How do I start forwarding Cortex Data Lake logs to an HTTPS receiver or SIEM?
      - Can I choose which log types get sent when I set up a new HTTPS forwarding destination?
      instructions:
      - text: Create an HTTPS profile that sends {logtypes} logs to receiver {destination}.
        slots:
          logtypes: requestBody.logtypes
          destination: requestBody.destination
      - text: Set up a new HTTPS log forwarding destination at {destination} for the {logtypes} log types.
        slots:
          destination: requestBody.destination
          logtypes: requestBody.logtypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/https-profiles/{profileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one HTTPS log forwarding profile
      effect: read
      questions:
      - What destination and log types is a specific HTTPS forwarding profile configured with?
      - Where do I get the etag I need before editing an HTTPS log forwarding profile?
      instructions:
      - text: Show HTTPS forwarding profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Fetch the etag and settings for log forwarding profile {profileId}.
        slots:
          profileId: path.profileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/https-profiles/{profileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an HTTPS log forwarding profile
      effect: write
      questions:
      - Can I change the receiver or log types on an HTTPS forwarding profile I already created?
      - Is it possible to change the profile type of an existing HTTPS forwarding profile?
      instructions:
      - text: Point HTTPS forwarding profile {profileId} at destination {destination}, keeping log types {logtypes}.
        slots:
          profileId: path.profileId
          destination: requestBody.destination
          logtypes: requestBody.logtypes
      - text: Update profile {profileId} using etag {etag} so it forwards {logtypes} to {destination}.
        slots:
          profileId: path.profileId
          etag: header.etag
          logtypes: requestBody.logtypes
          destination: requestBody.destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/logging-service/logforwarding/v1/https-profiles/{profileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an HTTPS log forwarding profile
      effect: destructive
      questions:
      - How do I stop forwarding logs to an HTTPS receiver I no longer use?
      - Can I remove an HTTPS forwarding profile by its profile ID?
      instructions:
      - text: Delete HTTPS forwarding profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Remove log forwarding profile {profileId} so logs stop going to that receiver.
        slots:
          profileId: path.profileId
      method: generated
      generated: '2026-09-26'