Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for public dlp DLP API (Beta) API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-dlp-api-beta-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['/v4/api/incidents'].get

$.paths['/v4/api/incidents'].post

$.paths['/v4/api/incidents/download'].post

$.paths['/v4/api/incidents/management'].post

$.paths['/v4/api/incidents/{id}'].get

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 public dlp DLP API (Beta) API
  version: 1.0.0
extends: openapi/palo-alto-networks-dlp-api-beta-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['/v4/api/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through DLP incidents with a token
      effect: read
      questions:
      - How do I fetch the next page of DLP incidents after my initial query?
      - Can I include data profiles when paging incident results?
      instructions:
      - text: Get DLP incidents with token {token} at offset {offset}, {pageSize} per page.
        slots:
          token: query.token
          offset: query.offset
          pageSize: query.pageSize
      - text: Continue incident results from token {token}, offset {offset}, page size {pageSize}, with data profiles {include_data_profiles}.
        slots:
          token: query.token
          offset: query.offset
          pageSize: query.pageSize
          include_data_profiles: query.include_data_profiles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/api/incidents'].post
  update:
    x-apievangelist-phrasing:
      intent: Query DLP incidents for a time range
      effect: read
      questions:
      - How do I start retrieving DLP incidents for a particular time range?
      - Can I choose columns and sort order when first querying incidents?
      instructions:
      - text: Get DLP incidents for time range {time_range}.
        slots:
          time_range: requestBody.time_range
      - text: Query incidents in {time_range} matching {filter}, sorted by {sort_by}, {page_size} per page.
        slots:
          time_range: requestBody.time_range
          filter: requestBody.filter
          sort_by: requestBody.sort_by
          page_size: requestBody.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/api/incidents/download'].post
  update:
    x-apievangelist-phrasing:
      intent: Export DLP incidents to a CSV download link
      effect: read
      questions:
      - Can I download DLP incidents as a CSV file?
      - How long is the signed incident export URL valid for?
      instructions:
      - text: Get a CSV download link for incidents in {time_range}.
        slots:
          time_range: requestBody.time_range
      - text: Export up to {max_rows} incidents from {time_range} matching {filter} as CSV.
        slots:
          max_rows: requestBody.max_rows
          time_range: requestBody.time_range
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/api/incidents/management'].post
  update:
    x-apievangelist-phrasing:
      intent: Update assignee, status or priority of DLP incidents
      effect: write
      questions:
      - How do I assign or resolve several DLP incidents at once?
      - Can I add tags and notes to incidents in bulk?
      instructions:
      - text: Update incidents {incident_ids} with {update_details}.
        slots:
          incident_ids: requestBody.incident_ids
          update_details: requestBody.update_details
      - text: Mark incidents {incident_ids} resolved by applying {update_details}.
        slots:
          incident_ids: requestBody.incident_ids
          update_details: requestBody.update_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/api/incidents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a DLP incident
      effect: read
      questions:
      - How do I see the full details of one DLP incident?
      - Can I include matched content snippets when viewing an incident?
      instructions:
      - text: Show DLP incident {id}.
        slots:
          id: path.id
      - text: Get incident {id} with snippets {includeSnippets}.
        slots:
          id: path.id
          includeSnippets: query.includeSnippets
      method: generated
      generated: '2026-09-26'