Palo Alto Networks · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Network Services IKE Gateways API
12 actions
12 updates
phrasing
extends
openapi/palo-alto-networks-ike-gateways-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/ike-gateways'].get
$.paths['/ike-gateways'].post
$.paths['/ike-gateways/{id}'].get
$.paths['/ike-gateways/{id}'].put
$.paths['/ike-gateways/{id}'].delete
$.paths['/ike-gateways:generate-ppk'].post
$.paths['/sse/config/v1/ike-gateways'].get
$.paths['/sse/config/v1/ike-gateways'].post
$.paths['/sse/config/v1/ike-gateways/{id}'].get
$.paths['/sse/config/v1/ike-gateways/{id}'].put
$.paths['/sse/config/v1/ike-gateways/{id}'].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 Network Services IKE Gateways API
version: 1.0.0
extends: openapi/palo-alto-networks-ike-gateways-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: 11
- target: $.paths['/ike-gateways'].get
update:
x-apievangelist-phrasing:
intent: List IKE gateways
effect: read
questions:
- Which IKE gateways are configured in Strata Cloud Manager?
- Can I filter IKE gateways by folder, snippet or device?
instructions:
- text: List all IKE gateways.
- text: List IKE gateways in folder {folder}.
slots:
folder: query.folder
- text: Find the IKE gateway named {name}.
slots:
name: query.name
method: generated
generated: '2026-09-26'
- target: $.paths['/ike-gateways'].post
update:
x-apievangelist-phrasing:
intent: Create an IKE gateway in the candidate config
effect: write
questions:
- How do I stage a new IKE gateway in the candidate configuration?
- What's needed for phase 1 when adding an IKE gateway for an IPSec tunnel?
instructions:
- text: Stage a new IKE gateway {name} for peer {peer_address} using protocol {protocol} in the candidate config.
slots:
name: requestBody.name
peer_address: requestBody.peer_address
protocol: requestBody.protocol
- text: Add candidate-config IKE gateway {name} to peer {peer_address} with authentication {authentication}.
slots:
name: requestBody.name
peer_address: requestBody.peer_address
authentication: requestBody.authentication
method: generated
generated: '2026-10-01'
- target: $.paths['/ike-gateways/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an IKE gateway
effect: read
questions:
- What peer and authentication settings does one IKE gateway have?
- Can I fetch a single IKE gateway by ID?
instructions:
- text: Get IKE gateway {id}.
slots:
id: path.id
- text: Show the settings of IKE gateway {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/ike-gateways/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update an IKE gateway
effect: write
questions:
- How do I change the peer address on an existing IKE gateway?
- Can I switch the authentication method of an IKE gateway?
instructions:
- text: Update IKE gateway {id} to peer {peer_address}.
slots:
id: path.id
peer_address: requestBody.peer_address
- text: Change the authentication on IKE gateway {id} to {authentication}.
slots:
id: path.id
authentication: requestBody.authentication
method: generated
generated: '2026-09-26'
- target: $.paths['/ike-gateways/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an IKE gateway
effect: destructive
questions:
- How do I remove an IKE gateway I no longer use?
- Is there a way to delete an IKE gateway by ID?
instructions:
- text: Delete IKE gateway {id}.
slots:
id: path.id
- text: Remove the IKE gateway {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/ike-gateways:generate-ppk'].post
update:
x-apievangelist-phrasing:
intent: Generate a post-quantum PPK key
effect: read
questions:
- How do I get a post-quantum pre-shared key for an IKE gateway?
- Can I choose the length of a generated PPK key per RFC 8784?
instructions:
- text: Generate a PPK key for IKE gateway configuration.
- text: Generate a hex-encoded post-quantum PPK of length {length}.
slots:
length: requestBody.length
method: generated
generated: '2026-09-26'
- target: $.paths['/sse/config/v1/ike-gateways'].get
update:
x-apievangelist-phrasing:
intent: List IKE gateways in an SSE config folder
effect: read
questions:
- Which IKE gateways are configured in a given Prisma Access folder?
- Can I look up an IKE gateway by name through the SSE config v1 endpoint?
instructions:
- text: List the IKE gateways in folder {folder} using the SSE config API.
slots:
folder: query.folder
- text: Find the SSE config IKE gateway named {name} in folder {folder}.
slots:
name: query.name
folder: query.folder
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-gateways'].post
update:
x-apievangelist-phrasing:
intent: Create an IKE gateway via SSE config
effect: write
questions:
- What do I need to create an IKE gateway through the SSE config v1 API?
- Can I choose the IKE protocol version when creating a gateway in a folder?
instructions:
- text: Create SSE config IKE gateway {name} to peer {peer_address} in folder {folder}.
slots:
name: requestBody.name
peer_address: requestBody.peer_address
folder: query.folder
- text: Add an IKE gateway {name} with protocol settings {protocol} in folder {folder} via SSE config.
slots:
name: requestBody.name
protocol: requestBody.protocol
folder: query.folder
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-gateways/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an IKE gateway via SSE config
effect: read
questions:
- How do I read one IKE gateway's settings through the SSE config v1 API?
- What authentication and peer details does a given SSE config IKE gateway use?
instructions:
- text: Get SSE config IKE gateway {id} from folder {folder}.
slots:
id: path.id
folder: query.folder
- text: Show the peer and auth settings of SSE config IKE gateway {id} in {folder}.
slots:
id: path.id
folder: query.folder
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-gateways/{id}'].put
update:
x-apievangelist-phrasing:
intent: Edit an IKE gateway via SSE config
effect: write
questions:
- Can I change the peer address of an IKE gateway through the SSE config v1 API?
- How do I modify IKE protocol settings on an existing SSE config gateway?
instructions:
- text: Edit SSE config IKE gateway {id} to point at peer {peer_address}.
slots:
id: path.id
peer_address: requestBody.peer_address
- text: Modify the protocol of SSE config IKE gateway {id} to {protocol}.
slots:
id: path.id
protocol: requestBody.protocol
method: generated
generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ike-gateways/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an IKE gateway via SSE config
effect: destructive
questions:
- How do I remove an IKE gateway using the SSE config v1 endpoint?
- Can I delete an unused IKE gateway from Prisma Access SSE config?
instructions:
- text: Delete SSE config IKE gateway {id}.
slots:
id: path.id
- text: Remove IKE gateway {id} through the SSE config v1 API.
slots:
id: path.id
method: generated
generated: '2026-10-01'