End-of-Life (EoL)
Use PAN-OS XML API to run various requests depending on the request type that you specify:
Request Types
You can currently use the following request types:
Syntax Description
type=keygen Generate API keys for authentication.
type=config Modify the configuration.
type=commit Commit firewall configuration, including partial commits.
type=op Perform operational mode commands, including checking system status and validating configurations.
type=report Get reports, including predefined, dynamic, and custom reports.
type=log Get logs, including traffic, threat, and event logs.
type=import Import files including configurations and certificates.
type=export Export files including packet captures, certificates, and keys.
type=user-id Update User-ID mappings.
type=version Show the PAN-OS version, serial number, and model number.
Configuration Actions
In addition to the request type that you specify, use available actions to modify or read configurations using type=config :
Actions for Modifying a Configuration
Configuration Action Type Syntax
Set candidate configuration action=set
Edit candidate configuration action=edit
Delete candidate object action=delete
Rename a configuration object action=rename
Clone a configuration object action=clone
Move a configuration object action=move
Override a template setting action=override
Move multiple objects in a device group or virtual system action=multi-move
Clone multiple objects in a device group or virtual system action=multi-clone
Show available subnode values and XPaths for a given XPath. action=complete
Set and edit actions differ in two important ways:
Set actions add, update, or merge configuration nodes, while edit actions replace configuration nodes. Set actions are non-destructive and are only additive, while edit actions can be destructive.
Actions for Reading a Configuration
Configuration Action Type Syntax
Get active configuration action=show
Get candidate configuration action=get
Show and get actions differ in three important ways:
Show actions retrieve the active configuration, while get actions retrieve the candidate, uncommitted configuration. Show actions only work when the provided XPath specifies a single node. Get actions work with single and multiple nodes. Show actions can use relative XPath, while get actions require absolute XPath.

Recommended For You