Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma Cloud Access Keys API Overview Data Security…

15 actions 15 updates phrasing extends openapi/palo-alto-networks-data-security-inventory-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 15

$.info
$.paths['/dlp/api/v1/inventory/data-scanned'].get
$.paths['/dlp/api/v1/inventory/object/data-classification/reportv2'].post
$.paths['/dlp/api/v1/inventory/object/data-classification/report'].post
$.paths['/dlp/api/v1/inventory/objects/aggregate'].post
$.paths['/dlp/api/v1/inventory/objects/aggregate/l4'].post
$.paths['/dlp/api/v1/inventory/object/details'].post
$.paths['/dlp/api/v1/inventory/objects/aggregate/by-classification'].post
$.paths['/dlp/api/v1/inventory/objects/aggregate/alerts/by-classification'].post
$.paths['/dlp/api/v1/inventory/objects/aggregate/history'].post
$.paths['/dlp/api/v1/inventory/object/malware/report/hash/{fileHash}'].post
$.paths['/dlp/api/v1/inventory/resource/details'].post
$.paths['/dlp/api/v1/inventory/resource/objects'].post
$.paths['/dlp/api/v1/inventory/snippet'].post
$.paths['/dlp/api/v1/inventory/snippet/objects/{objectId}/datapattern/{dataPatternId}'].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 Prisma Cloud Access Keys API Overview Data Security…
  version: 1.0.0
extends: openapi/palo-alto-networks-data-security-inventory-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: 14
- target: $.paths['/dlp/api/v1/inventory/data-scanned'].get
  update:
    x-apievangelist-phrasing:
      intent: Get data scanning usage for the tenant
      effect: read
      questions:
      - How much data has been scanned for my tenant so far?
      - What is my current data security scanning usage?
      instructions:
      - text: Show how much data has been scanned for my tenant.
      - text: Report my tenant's data security usage.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/object/data-classification/reportv2'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a data classification report with snippet masking
      effect: read
      questions:
      - Can I see the classification report for a file along with whether its snippets are masked?
      - Which sensitive data patterns were found in an object, including snippet masking status?
      instructions:
      - text: Get the v2 classification report with masking status for object {objectId} in tenant {tenantId}.
        slots:
          objectId: requestBody.objectId
          tenantId: requestBody.tenantId
      - text: Check whether snippets are masked in the classification report for object {objectId}.
        slots:
          objectId: requestBody.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/object/data-classification/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the original data classification report
      effect: read
      questions:
      - What sensitive data classifications were detected in a specific stored object?
      - Is there an older classification report endpoint without the masking details?
      instructions:
      - text: Pull the original classification report for object {objectId} in tenant {tenantId}.
        slots:
          objectId: requestBody.objectId
          tenantId: requestBody.tenantId
      - text: Show the first-version data classification results for {objectId}.
        slots:
          objectId: requestBody.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/objects/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: List data inventory objects by table level
      effect: read
      questions:
      - How many public, sensitive or malware-infected objects do I have per cloud service?
      - Can I group my data inventory by cloud type, region, account or resource type?
      - What is the maximum number of inventory items one request can return?
      instructions:
      - text: List data inventory at table level {tableLevel} grouped by {groupBy}.
        slots:
          tableLevel: requestBody.tableLevel
          groupBy: requestBody.groupBy
      - text: Show inventory objects at level {tableLevel} matching filters {filters}.
        slots:
          tableLevel: requestBody.tableLevel
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/objects/aggregate/l4'].post
  update:
    x-apievangelist-phrasing:
      intent: Page through bucket objects at level 4
      effect: read
      questions:
      - How can I quickly page through the individual objects inside a bucket?
      - Can I search objects in a bucket by name while paginating?
      instructions:
      - text: Get page {page} of level-4 bucket objects, {limit} per page.
        slots:
          page: requestBody.page
          limit: requestBody.limit
      - text: Search level-4 bucket objects for {searchTerm}, page {page} with {limit} results.
        slots:
          searchTerm: requestBody.searchTerm
          page: requestBody.page
          limit: requestBody.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/object/details'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one inventory object
      effect: read
      questions:
      - What do we know about a single file in my data inventory?
      - Can I look up an inventory object's details by its object ID?
      instructions:
      - text: Show details for inventory object {objectId} in tenant {tenantId}.
        slots:
          objectId: requestBody.objectId
          tenantId: requestBody.tenantId
      - text: Look up object {objectId} in the data inventory.
        slots:
          objectId: requestBody.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/objects/aggregate/by-classification'].post
  update:
    x-apievangelist-phrasing:
      intent: Count objects by classification, malware and exposure
      effect: read
      questions:
      - How many of my objects are classified sensitive, contain malware, or are publicly exposed?
      - Can I get object counts broken down by data classification?
      instructions:
      - text: Count objects by classification, malware and exposure at table level {tableLevel}.
        slots:
          tableLevel: requestBody.tableLevel
      - text: Break down object counts by classification for filters {filters} at level {tableLevel}.
        slots:
          filters: requestBody.filters
          tableLevel: requestBody.tableLevel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/objects/aggregate/alerts/by-classification'].post
  update:
    x-apievangelist-phrasing:
      intent: Count object alerts by exposure, classification and severity
      effect: read
      questions:
      - How many data alerts do I have grouped by exposure and severity?
      - Which classifications are driving the most object alerts?
      instructions:
      - text: Group object alert counts by exposure, classification and severity at level {tableLevel}.
        slots:
          tableLevel: requestBody.tableLevel
      - text: Show object alert totals for filters {filters} at table level {tableLevel}.
        slots:
          filters: requestBody.filters
          tableLevel: requestBody.tableLevel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/objects/aggregate/history'].post
  update:
    x-apievangelist-phrasing:
      intent: Count objects created in a time window
      effect: read
      questions:
      - How many objects were created in my data stores during a given time range?
      - Can I see how my data inventory has grown over time?
      instructions:
      - text: Count objects created within {timeRange} at table level {tableLevel}.
        slots:
          timeRange: requestBody.timeRange
          tableLevel: requestBody.tableLevel
      - text: Show inventory history at level {tableLevel}.
        slots:
          tableLevel: requestBody.tableLevel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/object/malware/report/hash/{fileHash}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the malware report for a file hash
      effect: read
      questions:
      - What does the malware report say about a file found in my cloud storage?
      - Can I look up malware findings for an object by its file hash?
      instructions:
      - text: Get the malware report for hash {fileHash} on object {objectId} in tenant {tenantId}.
        slots:
          fileHash: path.fileHash
          objectId: requestBody.objectId
          tenantId: requestBody.tenantId
      - text: Show malware analysis for file hash {fileHash}, object {objectId}.
        slots:
          fileHash: path.fileHash
          objectId: requestBody.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/resource/details'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of a storage bucket
      effect: read
      questions:
      - What does Prisma Cloud know about one of my storage buckets?
      - Can I see a bucket's data security details by tenant and bucket?
      instructions:
      - text: Show details for bucket {objectId} in tenant {tenantId}.
        slots:
          objectId: requestBody.objectId
          tenantId: requestBody.tenantId
      - text: Describe the storage bucket {objectId}.
        slots:
          objectId: requestBody.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/resource/objects'].post
  update:
    x-apievangelist-phrasing:
      intent: List the objects in a bucket
      effect: read
      questions:
      - Which files are stored in a particular bucket?
      - Can I list everything inside one of my scanned buckets?
      instructions:
      - text: List the objects in bucket {objectId} for tenant {tenantId}.
        slots:
          objectId: requestBody.objectId
          tenantId: requestBody.tenantId
      - text: Show the contents of bucket {objectId}.
        slots:
          objectId: requestBody.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/snippet'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a data snippet for an object
      effect: write
      questions:
      - How do I generate a snippet showing the sensitive content found in a file?
      - Can I request a new snippet for an object before viewing it?
      instructions:
      - text: Generate a snippet for object {objectId} in tenant {tenantId}.
        slots:
          objectId: requestBody.objectId
          tenantId: requestBody.tenantId
      - text: Create a fresh data snippet for {objectId}.
        slots:
          objectId: requestBody.objectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dlp/api/v1/inventory/snippet/objects/{objectId}/datapattern/{dataPatternId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a snippet for an object and data pattern
      effect: read
      questions:
      - Where can I see the matched text for a specific data pattern in a file?
      - Can I retrieve an already generated snippet for one data pattern?
      instructions:
      - text: Show the snippet for object {objectId} and data pattern {dataPatternId}.
        slots:
          objectId: path.objectId
          dataPatternId: path.dataPatternId
      - text: Fetch what data pattern {dataPatternId} matched in object {objectId}.
        slots:
          dataPatternId: path.dataPatternId
          objectId: path.objectId
      method: generated
      generated: '2026-09-26'