Palo Alto Networks · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for TLS Protect Cloud API for Strata Cloud Manager Machines API
11 actions
11 updates
phrasing
extends
openapi/palo-alto-networks-machines-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 11
$.info
$.paths['/v1/machines'].get
$.paths['/v1/machines'].post
$.paths['/v1/machines/{id}'].get
$.paths['/v1/machines/{id}'].delete
$.paths['/v1/machines/{id}'].patch
$.paths['/v1/machines/{id}/workflows'].post
$.paths['/v1/machinesearch'].post
$.paths['/v1/machines/{id}/batchprovisionings/abort'].post
$.paths['/v1/machines/{id}/discovery'].get
$.paths['/v1/machines/{id}/discovery/abort'].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 TLS Protect Cloud API for Strata Cloud Manager Machines API
version: 1.0.0
extends: openapi/palo-alto-networks-machines-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: 10
- target: $.paths['/v1/machines'].get
update:
x-apievangelist-phrasing:
intent: List all machines
effect: read
questions:
- Which machines are registered for certificate provisioning?
- Can I get every machine and its details in one call?
instructions:
- text: List all machines.
- text: Show the details of every machine I have.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines'].post
update:
x-apievangelist-phrasing:
intent: Add a machine
effect: write
questions:
- How do I register a new machine with a plugin and connection details?
- Can I assign an owning team and tags when adding a machine?
instructions:
- text: Add machine {name} using plugin {pluginId} with connection details {connectionDetails}.
slots:
name: requestBody.name
pluginId: requestBody.pluginId
connectionDetails: requestBody.connectionDetails
- text: Create machine {name} on plugin {pluginId} owned by team {owningTeamId}.
slots:
name: requestBody.name
pluginId: requestBody.pluginId
owningTeamId: requestBody.owningTeamId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a machine's details
effect: read
questions:
- What are the connection details and status of one machine?
- Can I look up a single machine by its id?
instructions:
- text: Get machine {id}.
slots:
id: path.id
- text: Show the details of machine {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a machine
effect: destructive
questions:
- How do I remove a machine from the inventory?
- Is deleting a machine by id reversible?
instructions:
- text: Delete machine {id}.
slots:
id: path.id
- text: Remove machine {id} permanently.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a machine's settings
effect: write
questions:
- Can I turn on scheduled discovery for an existing machine?
- How do I change a machine's connection details or owning team?
- Is it possible to enable batch provisioning on a schedule for one machine?
instructions:
- text: Rename machine {id} to {name}.
slots:
id: path.id
name: requestBody.name
- text: Enable discovery on machine {id} with schedule {discoverySchedulerPattern}.
slots:
id: path.id
discoverySchedulerPattern: requestBody.discoverySchedulerPattern
- text: Move machine {id} to satellite {edgeInstanceId}.
slots:
id: path.id
edgeInstanceId: requestBody.edgeInstanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines/{id}/workflows'].post
update:
x-apievangelist-phrasing:
intent: Start a workflow on a machine
effect: write
questions:
- How do I kick off a named workflow on a machine?
- Can I pass input data when triggering a machine workflow?
instructions:
- text: Start workflow {workflowName} on machine {id}.
slots:
workflowName: requestBody.workflowName
id: path.id
- text: Trigger workflow {workflowName} on machine {id} with input {workflowInput}.
slots:
workflowName: requestBody.workflowName
id: path.id
workflowInput: requestBody.workflowInput
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machinesearch'].post
update:
x-apievangelist-phrasing:
intent: Search machines by expression
effect: read
questions:
- Can I find machines that match a search expression, with paging and ordering?
- Which machines match a filter like a status or plugin?
instructions:
- text: Search machines matching {expression}.
slots:
expression: requestBody.expression
- text: Find machines with {expression} ordered by {ordering}.
slots:
expression: requestBody.expression
ordering: requestBody.ordering
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines/{id}/batchprovisionings/abort'].post
update:
x-apievangelist-phrasing:
intent: Abort a machine's batch provisioning
effect: destructive
questions:
- How do I stop a batch provisioning run that is in progress on a machine?
- Can I cancel certificate batch provisioning for one machine?
instructions:
- text: Abort the active batch provisioning on machine {id}.
slots:
id: path.id
- text: Cancel batch provisioning currently running for machine {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines/{id}/discovery'].get
update:
x-apievangelist-phrasing:
intent: Get a machine's discovery results
effect: read
questions:
- What did the last discovery on a machine find?
- Can I see discovery results for one machine?
instructions:
- text: Get the discovery results of machine {id}.
slots:
id: path.id
- text: Show what discovery found on machine {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/machines/{id}/discovery/abort'].post
update:
x-apievangelist-phrasing:
intent: Abort a machine discovery
effect: destructive
questions:
- How do I stop a discovery that is running on a machine?
- Can an active machine discovery be aborted midway?
instructions:
- text: Abort the running discovery on machine {id}.
slots:
id: path.id
- text: Stop discovery for machine {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'