Each of the PAN-OS XML API
requests begin with an request type, the following request types filter the rest of
the available configurations. For config type requests, you can combine a request
type with an action using an ampersand to specify how PAN-OS should interpret your
request. For
example:
https://firewall/api?type=config&action=set
The
previous query is the basis for using the configuration actions. Explore the XML API to learn more
about the accepted paremeters for each of the request types listed below.
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.
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.
