Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services URL Access Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-url-access-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 11

$.info
$.paths['/url-access-profiles'].get
$.paths['/url-access-profiles'].post
$.paths['/url-access-profiles/{id}'].get
$.paths['/url-access-profiles/{id}'].put
$.paths['/url-access-profiles/{id}'].delete
$.paths['/sse/config/v1/url-access-profiles'].get
$.paths['/sse/config/v1/url-access-profiles'].post
$.paths['/sse/config/v1/url-access-profiles/{id}'].get
$.paths['/sse/config/v1/url-access-profiles/{id}'].put
$.paths['/sse/config/v1/url-access-profiles/{id}'].delete

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 Security Services URL Access Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-url-access-profiles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/url-access-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List URL access profiles
      effect: read
      questions:
      - Which URL filtering profiles are configured?
      - Can I look up a URL access profile by name?
      instructions:
      - text: List all URL access profiles.
      - text: Find the URL access profile named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-access-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a URL access profile
      effect: write
      questions:
      - How do I create a URL filtering profile that blocks certain categories?
      - Can I enforce safe search in a new URL access profile?
      instructions:
      - text: Create URL access profile {name} blocking categories {block}.
        slots:
          name: requestBody.name
          block: requestBody.block
      - text: Create URL access profile {name} with safe search enforcement {safe_search_enforcement}.
        slots:
          name: requestBody.name
          safe_search_enforcement: requestBody.safe_search_enforcement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-access-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a URL access profile
      effect: read
      questions:
      - Which categories does a particular URL access profile allow or block?
      - Can I fetch one URL access profile by ID?
      instructions:
      - text: Get URL access profile {id}.
        slots:
          id: path.id
      - text: Show the category actions of URL access profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-access-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL access profile
      effect: write
      questions:
      - How do I add categories to the block list of an existing URL access profile?
      - Can I turn on credential phishing enforcement for a profile I already have?
      instructions:
      - text: Update URL access profile {id} to block {block}.
        slots:
          id: path.id
          block: requestBody.block
      - text: Set credential enforcement on URL access profile {id} to {credential_enforcement}.
        slots:
          id: path.id
          credential_enforcement: requestBody.credential_enforcement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/url-access-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a URL access profile
      effect: destructive
      questions:
      - How do I remove a URL access profile?
      - Is deleting a URL filtering profile permanent?
      instructions:
      - text: Delete URL access profile {id}.
        slots:
          id: path.id
      - text: Remove the URL access profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/url-access-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List URL access profiles
      effect: read
      questions:
      - Which URL filtering access profiles exist in a folder?
      - Can I find a URL access profile by name?
      instructions:
      - text: List URL access profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find URL access profile {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-access-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a URL access profile
      effect: write
      questions:
      - Within a specific folder, how do I set up a URL filtering profile blocking chosen categories?
      - Can a URL access profile I create in a folder enforce safe search?
      instructions:
      - text: Create URL access profile {name} in folder {folder} blocking categories {block}.
        slots:
          name: requestBody.name
          folder: query.folder
          block: requestBody.block
      - text: Create URL profile {name} in folder {folder} with safe search enforcement {safe_search_enforcement}.
        slots:
          name: requestBody.name
          folder: query.folder
          safe_search_enforcement: requestBody.safe_search_enforcement
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-access-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a URL access profile
      effect: read
      questions:
      - Which URL categories does a specific access profile allow, alert or block?
      - Can I fetch a URL access profile by ID?
      instructions:
      - text: Show URL access profile {id}.
        slots:
          id: path.id
      - text: Get the blocked and allowed categories in URL profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-access-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a URL access profile
      effect: write
      questions:
      - How do I change the blocked categories on an existing URL access profile?
      - Through the SSE config v1 path, can I enable credential phishing enforcement on an existing URL profile?
      instructions:
      - text: Update URL access profile {id} named {name} to alert on {alert}.
        slots:
          id: path.id
          name: requestBody.name
          alert: requestBody.alert
      - text: Edit URL profile {id} ({name}) via the SSE config v1 path so credential phishing enforcement is {credential_enforcement}.
        slots:
          id: path.id
          name: requestBody.name
          credential_enforcement: requestBody.credential_enforcement
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/url-access-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a URL access profile
      effect: destructive
      questions:
      - How do I delete a URL access profile?
      - Will security rules using a URL profile break if I delete it?
      instructions:
      - text: Delete URL access profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the unused URL filtering profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'