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.
# 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 Configuration API
version: 1.0.0
extends: openapi/palo-alto-networks-configuration-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: 3
- target: $.paths['/config-versions/candidate:push'].post
update:
x-apievangelist-phrasing:
intent: Push the candidate configuration
effect: write
questions:
- How do I push my candidate configuration out to devices?
- Can I push only some folders' candidate config with a description?
instructions:
- text: Push the candidate configuration for folders {folders}.
slots:
folders: requestBody.folders
- text: Push all staged candidate changes live with note {description}.
slots:
description: requestBody.description
method: generated
generated: '2026-10-01'
- target: $.paths['/jobs/{id}'].get
update:
x-apievangelist-phrasing:
intent: Check an asynchronous job's status
effect: read
questions:
- Has my configuration push finished yet?
- Where do I poll the progress of a long-running config job?
instructions:
- text: Get the status of job {id}.
slots:
id: path.id
- text: Check whether config push job {id} has completed.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/sse/config/v1/config-versions/candidate:push'].post
update:
x-apievangelist-phrasing:
intent: Push candidate config to folders (SSE v1)
effect: write
questions:
- Can I deploy staged changes to firewalls in specific folders through the SSE config v1 API?
- What job ID comes back when I push config to selected folders?
instructions:
- text: Push the candidate configuration to folders {folders} via SSE config v1.
slots:
folders: requestBody.folders
- text: Deploy staged SSE v1 changes to {folders} with note {description}.
slots:
folders: requestBody.folders
description: requestBody.description
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.