Palo Alto Networks · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for TLS Protect Cloud API for Strata Cloud Manager V Satellite…
15 actions
15 updates
phrasing
extends
openapi/palo-alto-networks-vsatellite-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 15
$.info
$.paths['/v1/edgeinstances/{id}/update'].post
$.paths['/v1/edgeencryptionkeys'].get
$.paths['/v1/edgeencryptionkeys/{id}'].get
$.paths['/v1/edgeinstances'].get
$.paths['/v1/edgeinstances/{id}'].get
$.paths['/v1/edgeinstances/{id}'].put
$.paths['/v1/pairingcodes/satellite'].post
$.paths['/v1/recoverycodes/satellite'].post
$.paths['/v1/edgeworkers'].get
$.paths['/v1/edgeworkers'].post
$.paths['/v1/edgeworkers/{id}/pair'].post
$.paths['/v1/edgeworkers/{id}'].delete
$.paths['/v1/updatesconfig'].get
$.paths['/v1/updatesconfig'].patch
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 TLS Protect Cloud API for Strata Cloud Manager V Satellite…
version: 1.0.0
extends: openapi/palo-alto-networks-vsatellite-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: 14
- target: $.paths['/v1/edgeinstances/{id}/update'].post
update:
x-apievangelist-phrasing:
intent: Trigger a manual Satellite instance update
effect: write
questions:
- Can I force a VSatellite instance to update now instead of waiting for the update window?
- What starts a manual software update on one satellite instance?
instructions:
- text: Trigger a manual update of satellite instance {id}.
slots:
id: path.id
- text: Start updating VSatellite {id} right now.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeencryptionkeys'].get
update:
x-apievangelist-phrasing:
intent: List Satellite encryption keys
effect: read
questions:
- Which encryption keys are registered for my VSatellite deployments?
- Can I list only the encryption keys belonging to one satellite instance?
instructions:
- text: List all satellite encryption keys.
- text: Show the encryption keys for satellite instance {edgeInstanceId}.
slots:
edgeInstanceId: query.edgeInstanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeencryptionkeys/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a Satellite encryption key
effect: read
questions:
- How do I look up a single satellite encryption key by its id?
- Is the encryption key id a string rather than a number?
instructions:
- text: Get satellite encryption key {id}.
slots:
id: path.id
- text: Show details of the VSatellite encryption key with id {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeinstances'].get
update:
x-apievangelist-phrasing:
intent: List Satellite instances
effect: read
questions:
- Which VSatellite instances does my company have deployed?
- Can I filter satellite instances by environment?
instructions:
- text: List all satellite instances.
- text: List satellite instances in environment {environmentId}.
slots:
environmentId: query.environmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeinstances/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a Satellite instance
effect: read
questions:
- What is the current state of one of my VSatellite instances?
- Can I include detailed status information when fetching a single satellite?
instructions:
- text: Get satellite instance {id}.
slots:
id: path.id
- text: Show satellite instance {id} with status details {statusDetails}.
slots:
id: path.id
statusDetails: query.statusDetails
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeinstances/{id}'].put
update:
x-apievangelist-phrasing:
intent: Rename or reprioritize a Satellite instance
effect: write
questions:
- How do I rename a VSatellite instance?
- Can I change the order in which a satellite gets upgraded?
instructions:
- text: Rename satellite instance {id} to {name}.
slots:
id: path.id
name: requestBody.name
- text: Set satellite {id} name to {name} with upgrade priority {upgradeOrderPriority}.
slots:
id: path.id
name: requestBody.name
upgradeOrderPriority: requestBody.upgradeOrderPriority
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/pairingcodes/satellite'].post
update:
x-apievangelist-phrasing:
intent: Generate a Satellite pairing code
effect: write
questions:
- How do I get a pairing code to register a new VSatellite instance?
- Can one pairing code be reused to register several satellites?
instructions:
- text: Generate a satellite pairing code for environment {environmentId}.
slots:
environmentId: requestBody.environmentId
- text: Create a pairing code usable {reuseCount} times for primary instance {primaryInstanceId}.
slots:
reuseCount: requestBody.reuseCount
primaryInstanceId: requestBody.primaryInstanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/recoverycodes/satellite'].post
update:
x-apievangelist-phrasing:
intent: Generate a Satellite recovery code
effect: write
questions:
- How do I restore a VSatellite instance that I need to rebuild?
- What code do I need to recover a lost satellite instance?
instructions:
- text: Generate a recovery code for satellite instance {edgeInstanceId}.
slots:
edgeInstanceId: requestBody.edgeInstanceId
- text: Create a restoration code so I can recover VSatellite {edgeInstanceId}.
slots:
edgeInstanceId: requestBody.edgeInstanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeworkers'].get
update:
x-apievangelist-phrasing:
intent: List Satellite workers
effect: read
questions:
- Which satellite workers are running for my company?
- Can I see only the workers attached to one satellite instance?
instructions:
- text: List all satellite workers.
- text: List the workers of satellite instance {edgeInstanceId}.
slots:
edgeInstanceId: query.edgeInstanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeworkers'].post
update:
x-apievangelist-phrasing:
intent: Create a Satellite worker
effect: write
questions:
- How do I add a worker to a VSatellite and get its pairing information?
- What host and port does a new satellite worker need?
instructions:
- text: Create a satellite worker on host {host} port {port} for instance {edgeInstanceId}.
slots:
host: requestBody.host
port: requestBody.port
edgeInstanceId: requestBody.edgeInstanceId
- text: Add a new worker to satellite {edgeInstanceId} and return its pairing details.
slots:
edgeInstanceId: requestBody.edgeInstanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeworkers/{id}/pair'].post
update:
x-apievangelist-phrasing:
intent: Pair a worker with a Satellite instance
effect: write
questions:
- How do I attach an existing satellite worker to a satellite instance?
- Can I re-pair a worker onto a different VSatellite?
instructions:
- text: Pair worker {id} with satellite instance {edgeInstanceId}.
slots:
id: path.id
edgeInstanceId: requestBody.edgeInstanceId
- text: Pair satellite worker {id} using host {host} and port {port}.
slots:
id: path.id
host: requestBody.host
port: requestBody.port
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/edgeworkers/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Satellite worker
effect: destructive
questions:
- How do I remove a satellite worker I no longer need?
- Is deleting a VSatellite worker permanent?
instructions:
- text: Delete satellite worker {id}.
slots:
id: path.id
- text: Remove worker {id} from its VSatellite.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/updatesconfig'].get
update:
x-apievangelist-phrasing:
intent: Get the Satellite update schedule
effect: read
questions:
- When is my tenant's VSatellite update window scheduled?
- What update configuration is currently set for my satellites?
instructions:
- text: Show the satellite updates configuration.
- text: Get my tenant's update window settings.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/updatesconfig'].patch
update:
x-apievangelist-phrasing:
intent: Set the Satellite update schedule
effect: write
questions:
- Can I restrict satellite updates to a nightly maintenance window?
- What is the default update schedule if I never configure one?
instructions:
- text: Set the satellite update schedule to {updateConfigSchedulerPattern}.
slots:
updateConfigSchedulerPattern: requestBody.updateConfigSchedulerPattern
- text: Change the update window pattern to {updateConfigSchedulerPattern}.
slots:
updateConfigSchedulerPattern: requestBody.updateConfigSchedulerPattern
method: generated
generated: '2026-09-26'