Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks IKE Crypto Profiles API

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

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

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 IKE Crypto Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-ike-crypto-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: 16
- target: $.paths['/v1/ike-crypto-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Check status of IKE crypto profile creation
      effect: read
      questions:
      - Did my IKE crypto profile request finish, and what UUID was assigned?
      - Can I see the status of an IKE crypto profile job by its ID on the v1 endpoint?
      instructions:
      - text: Check the status of IKE crypto profile job {id}.
        slots:
          id: query.id
      - text: Get the v1 IKE crypto profile status and UUID for request {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ike-crypto-profiles'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an IKE crypto profile (v1)
      effect: write
      questions:
      - Can I change the encryption or DH group of an IKE crypto profile for a sub-tenant?
      - Which settings must I resend when editing a v1 IKE crypto profile?
      instructions:
      - text: Edit v1 IKE crypto profile {name} to use {encryption}, hash {hash} and DH group {dh_group}.
        slots:
          name: requestBody.name
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
      - text: Update IKE profile {name} for sub-tenant {SubTenantName} with lifetime {lifetime}, {encryption}, {hash}, {dh_group}.
        slots:
          name: requestBody.name
          SubTenantName: query.SubTenantName
          lifetime: requestBody.lifetime
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ike-crypto-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IKE crypto profile (v1)
      effect: write
      questions:
      - How do I add a new IKE crypto profile for a sub-tenant?
      - What encryption, hash and DH group values does a new v1 IKE profile need?
      instructions:
      - text: Create v1 IKE crypto profile {name} with {encryption}, hash {hash}, DH group {dh_group}.
        slots:
          name: requestBody.name
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
      - text: Add IKE profile {name} for sub-tenant {SubTenantName} using {encryption}/{hash}/{dh_group}.
        slots:
          name: requestBody.name
          SubTenantName: query.SubTenantName
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ike-crypto-profiles'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IKE crypto profile by name (v1)
      effect: destructive
      questions:
      - How do I remove an IKE crypto profile by its name for a sub-tenant?
      - Is there a v1 call to delete an IKE profile without knowing its UUID?
      instructions:
      - text: Delete v1 IKE crypto profile {name}.
        slots:
          name: query.name
      - text: Remove IKE profile {name} from sub-tenant {SubTenantName}.
        slots:
          name: query.name
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ike-crypto-profiles-read'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch results of an IKE profile read request
      effect: read
      questions:
      - Where do I collect the IKE crypto profile list after submitting a read request?
      - Can I retrieve the output of an IKE profiles read job by its ID?
      instructions:
      - text: Fetch the IKE crypto profiles list for read request {id}.
        slots:
          id: query.id
      - text: Get the results of IKE profiles read job {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ike-crypto-profiles-read'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a request to read IKE crypto profiles
      effect: read
      questions:
      - How do I start a read of specific IKE crypto profiles by name?
      - Can I request the IKE profile list for just one sub-tenant?
      instructions:
      - text: Submit a read request for IKE profiles {ike_crypto_profiles_names}.
        slots:
          ike_crypto_profiles_names: requestBody.ike_crypto_profiles_names
      - text: Request the IKE crypto profile list for sub-tenant {SubTenantName}.
        slots:
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ike-crypto-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List IKE crypto profiles in a folder
      effect: read
      questions:
      - What IKE crypto profiles are defined in a configuration folder or snippet?
      - Can I filter IKE crypto profiles by device and page through them?
      instructions:
      - text: List IKE crypto profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: List IKE crypto profiles in snippet {snippet}, {limit} at a time.
        slots:
          snippet: query.snippet
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ike-crypto-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IKE crypto profile
      effect: write
      questions:
      - How do I define a new IKE crypto profile for my VPN tunnels?
      - Can a new IKE crypto profile allow multiple authentication or AKE settings?
      instructions:
      - text: Create IKE crypto profile {name} with {encryption}, hash {hash} and DH group {dh_group} in the configuration.
        slots:
          name: requestBody.name
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
      - text: 'Define IKE profile {name}: encryption {encryption}, hash {hash}, DH {dh_group}, lifetime {lifetime}.'
        slots:
          name: requestBody.name
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
          lifetime: requestBody.lifetime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ike-crypto-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IKE crypto profile by ID
      effect: read
      questions:
      - What encryption and hash settings does a specific IKE crypto profile use?
      - Can I look up one IKE crypto profile by its ID?
      instructions:
      - text: Get IKE crypto profile {id}.
        slots:
          id: path.id
      - text: Show the settings of IKE crypto profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ike-crypto-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an IKE crypto profile by ID
      effect: write
      questions:
      - Can I change the key lifetime of an existing IKE crypto profile identified by ID?
      - How do I switch an IKE crypto profile's DH group?
      instructions:
      - text: 'Update IKE crypto profile {id}: name {name}, {encryption}, hash {hash}, DH {dh_group}.'
        slots:
          id: path.id
          name: requestBody.name
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
      - text: Change profile {id} ({name}) to lifetime {lifetime} with {encryption}/{hash}/{dh_group}.
        slots:
          id: path.id
          name: requestBody.name
          lifetime: requestBody.lifetime
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ike-crypto-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IKE crypto profile by ID
      effect: destructive
      questions:
      - How do I delete an IKE crypto profile using its ID?
      - Will removing an IKE crypto profile by ID be permanent?
      instructions:
      - text: Delete IKE crypto profile {id}.
        slots:
          id: path.id
      - text: Remove the IKE crypto profile with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/ike-crypto-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List IKE crypto profiles
      effect: read
      questions:
      - Which IKE crypto profiles are available in a folder?
      - Can I search IKE crypto profiles by name?
      instructions:
      - text: List IKE crypto profiles in folder {folder} through the SSE config v1 path.
        slots:
          folder: query.folder
      - text: Find IKE crypto profile {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-crypto-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IKE crypto profile
      effect: write
      questions:
      - How do I define the DH group, encryption and hash for IKE phase 1?
      - Can I set a key lifetime on a new IKE crypto profile?
      instructions:
      - text: Create IKE crypto profile {name} with DH group {dh_group}, encryption {encryption}, hash {hash} in folder {folder}.
        slots:
          name: requestBody.name
          dh_group: requestBody.dh_group
          encryption: requestBody.encryption
          hash: requestBody.hash
          folder: query.folder
      - text: Add IKE profile {name} using {encryption}/{hash}, group {dh_group}, lifetime {lifetime}, folder {folder}.
        slots:
          name: requestBody.name
          encryption: requestBody.encryption
          hash: requestBody.hash
          dh_group: requestBody.dh_group
          lifetime: requestBody.lifetime
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-crypto-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IKE crypto profile
      effect: read
      questions:
      - What encryption and DH group does one IKE crypto profile use?
      - Is the folder required to read an IKE crypto profile by ID?
      instructions:
      - text: Get IKE crypto profile {id} in folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      - text: Show the ciphers of IKE profile {id} from folder {folder}.
        slots:
          id: path.id
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-crypto-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an IKE crypto profile
      effect: write
      questions:
      - Can I switch an IKE crypto profile to a stronger DH group?
      - How do I change the hash algorithm on an existing IKE profile?
      instructions:
      - text: Edit IKE crypto profile {id} ({name}) to DH group {dh_group}, encryption {encryption}, hash {hash}.
        slots:
          id: path.id
          name: requestBody.name
          dh_group: requestBody.dh_group
          encryption: requestBody.encryption
          hash: requestBody.hash
      - text: Change the key lifetime on IKE profile {id} to {lifetime}.
        slots:
          id: path.id
          lifetime: requestBody.lifetime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-crypto-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IKE crypto profile
      effect: destructive
      questions:
      - How do I delete an IKE crypto profile I no longer use?
      - Will removing an IKE crypto profile break gateways that reference it?
      instructions:
      - text: Delete IKE crypto profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the IKE profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'