Palo Alto Networks · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for SP Manage Interconnect API
10 actions
10 updates
phrasing
extends
openapi/palo-alto-networks-interconnect-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 10
$.info
$.paths['/mt/sp-interconnect/interconnects'].get
$.paths['/mt/sp-interconnect/interconnects'].post
$.paths['/mt/sp-interconnect/interconnects/summary'].get
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}'].get
$.paths['/mt/sp-interconnect/interconnects/{interconnectId}'].delete
$.paths['/mt/sp-interconnect/regions'].get
$.paths['/mt/sp-interconnect/regions/physical-connections'].get
$.paths['/mt/sp-interconnect/settings'].get
$.paths['/mt/sp-interconnect/settings'].post
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 SP Manage Interconnect API
version: 1.0.0
extends: openapi/palo-alto-networks-interconnect-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: 9
- target: $.paths['/mt/sp-interconnect/interconnects'].get
update:
x-apievangelist-phrasing:
intent: List all Service Provider Interconnects
effect: read
questions:
- Which SP Interconnects are configured across my AWS and GCP regions?
- Can I include the default interconnect and associated tenants in the inventory?
instructions:
- text: List all Service Provider Interconnects.
- text: List interconnects with default included set to {includeDefaultInterconnect} and tenants set to {includeTenantsAssociated}.
slots:
includeDefaultInterconnect: query.includeDefaultInterconnect
includeTenantsAssociated: query.includeTenantsAssociated
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects'].post
update:
x-apievangelist-phrasing:
intent: Provision a new Service Provider Interconnect
effect: write
questions:
- How do I set up a private interconnect between my service provider network and Prisma Access?
- Can I create a per-tenant interconnect rather than a shared one?
instructions:
- text: Create interconnect {name} in {region} on {cloudProvider}, type {type}, usage {usage}, partner {partnerName} at {partnerEmail}.
slots:
name: requestBody.name
region: requestBody.region
cloudProvider: requestBody.cloudProvider
type: requestBody.type
usage: requestBody.usage
partnerName: requestBody.partnerName
partnerEmail: requestBody.partnerEmail
- text: Provision a {usage} interconnect named {name} for tenant group {tsgId} in {region} on {cloudProvider}, type {type}, contact {partnerName} {partnerEmail}.
slots:
usage: requestBody.usage
name: requestBody.name
tsgId: requestBody.tsgId
region: requestBody.region
cloudProvider: requestBody.cloudProvider
type: requestBody.type
partnerName: requestBody.partnerName
partnerEmail: requestBody.partnerEmail
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/summary'].get
update:
x-apievangelist-phrasing:
intent: Summarize interconnect health and capacity
effect: read
questions:
- How many of my interconnects are active versus inactive?
- What is the total IP pool usage and bandwidth split across cloud providers?
instructions:
- text: Give me the interconnect summary dashboard numbers.
- text: Summarize interconnects for usage model {usage}.
slots:
usage: query.usage
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}'].get
update:
x-apievangelist-phrasing:
intent: Get one interconnect's configuration and status
effect: read
questions:
- What VLAN attachments and status does a specific interconnect have?
- Which tenants are currently using a particular interconnect?
instructions:
- text: Show interconnect {interconnectId}.
slots:
interconnectId: path.interconnectId
- text: Get interconnect {interconnectId} with associated tenants {includeTenantsAssociated}.
slots:
interconnectId: path.interconnectId
includeTenantsAssociated: query.includeTenantsAssociated
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/interconnects/{interconnectId}'].delete
update:
x-apievangelist-phrasing:
intent: Permanently remove an interconnect
effect: destructive
questions:
- How do I retire an interconnect we no longer need for egress?
- Do I have to delete VLAN attachments before removing an interconnect?
instructions:
- text: Delete interconnect {interconnectId}.
slots:
interconnectId: path.interconnectId
- text: Permanently retire the interconnect with ID {interconnectId}.
slots:
interconnectId: path.interconnectId
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/regions'].get
update:
x-apievangelist-phrasing:
intent: List supported interconnect regions and edges
effect: read
questions:
- Which regions and edge locations support SP Interconnect?
- What's the closest interconnect edge location for my AWS infrastructure?
instructions:
- text: List SP Interconnect regions and edge locations.
- text: Show interconnect regions available on cloud provider {cloudProvider}.
slots:
cloudProvider: query.cloudProvider
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/regions/physical-connections'].get
update:
x-apievangelist-phrasing:
intent: List GCP colocation sites for physical links
effect: read
questions:
- Where can I provision a physical interconnect link on the GCP network?
- Which colocation facilities are available for dedicated physical connections?
instructions:
- text: List the GCP physical connection regions and facilities.
- text: Show continents, cities and colocation facilities for physical interconnects.
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/settings'].get
update:
x-apievangelist-phrasing:
intent: Check a tenant's egress routing setting
effect: read
questions:
- Is my tenant's egress traffic going over the SP Interconnect or the public path?
- Which CIDR blocks currently participate in private egress routing?
instructions:
- text: Show my current egress settings.
- text: Tell me the egress type and CIDRs configured for this tenant.
method: generated
generated: '2026-09-26'
- target: $.paths['/mt/sp-interconnect/settings'].post
update:
x-apievangelist-phrasing:
intent: Configure a tenant's egress routing
effect: write
questions:
- How do I switch a tenant's egress traffic to the private service provider path?
- Which CIDR ranges do I need to specify when choosing SP egress?
instructions:
- text: Set egress type to {egressType}.
slots:
egressType: requestBody.egressType
- text: Route CIDRs {cidr} over egress type {egressType}.
slots:
cidr: requestBody.cidr
egressType: requestBody.egressType
method: generated
generated: '2026-09-26'