Home
EN
Location
Documentation Home
Palo Alto Networks
Support
Live Community
Knowledge Base
Clear
PAN-OS® and Panorama™API Usage Guide
:
Request Types
Updated on
Jan 10, 2024
Focus
Download PDF
Updated on
Jan 10, 2024
Focus
Home
PAN-OS
PAN-OS® and Panorama™API Usage Guide
PAN-OS XML API Request Types
PAN-OS XML API Request Types and Actions
Request Types
Download PDF
PAN-OS® and Panorama™API Usage Guide
Request Types
Table of Contents
Filter
Version
10.1
PAN-OS 11.1 & Later
11.0 (EoL)
10.2
10.1
10.0 (EoL)
9.1 (EoL)
Expand all
|
Collapse all
About the PAN-OS API
PAN-OS XML API Components
Structure of a PAN-OS XML API Request
API Authentication and Security
XML and XPath
XPath Node Selection
Get Started with the PAN-OS XML API
Enable API Access
Get Your API Key
Authenticate Your API Requests
Make Your First API Call
Explore the API
Use the API Browser
Use the CLI to Find XML API Syntax
Use the Web Interface to Find XML API Syntax
PAN-OS XML API Error Codes
PAN-OS XML API Use Cases
Upgrade a Firewall to the Latest PAN-OS Version (API)
Show and Manage GlobalProtect Users (API)
Query a Firewall from Panorama (API)
Upgrade PAN-OS on Multiple HA Firewalls through Panorama (API)
Automatically Check for and Install Content Updates (API)
Enforce Policy using External Dynamic Lists and AutoFocus Artifacts (API)
Configure SAML 2.0 Authentication (API)
Quarantine Compromised Devices (API)
Manage Certificates (API)
PAN-OS XML API Request Types
PAN-OS XML API Request Types and Actions
Request Types
Configuration Actions
Actions for Modifying a Configuration
Actions for Reading a Configuration
Asynchronous and Synchronous Requests to the PAN-OS XML API
Configuration (API)
Get Active Configuration
Use XPath to Get Active Configuration
Use XPath to Get ARP Information
Get Candidate Configuration
Set Configuration
Edit Configuration
Delete Configuration
Rename Configuration
Clone Configuration
Move Configuration
Override Configuration
Multi-Move or Multi-Clone Configuration
Multi-config Request (API)
View Configuration Node Values for XPath
Commit Configuration (API)
Commit
Commit-All
Run Operational Mode Commands (API)
Get Reports (API)
Dynamic Reports
Predefined Reports
Custom Reports
Export Files (API)
Export Packet Captures
Export Application PCAPS
Export Threat, Filter, and Data Filtering PCAPs
Export Certificates and Keys
Export Technical Support Data
Import Files (API)
Importing Basics
Import Files
Retrieve Logs (API)
API Log Retrieval Parameters
Example: Use the API to Retrieve Traffic Logs
Apply User-ID Mapping and Populate Dynamic Groups (API)
Get Version Info (API)
Get Started with the PAN-OS REST API
PAN-OS REST API
Access the PAN-OS REST API
Resource Methods and Query Parameters (REST API)
PAN-OS REST API Request and Response Structure
PAN-OS REST API Error Codes
Work With Objects (REST API)
Create a Security Policy Rule (REST API)
Work with Policy Rules on Panorama (REST API)
Create a Tag (REST API)
Configure a Security Zone (REST API)
Configure an SD-WAN Interface (REST API)
Create an SD-WAN Policy Pre Rule (REST API)
Configure an Ethernet Interface (REST API)
Update a Virtual Router (REST API)
Work With Decryption (APIs)
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.
Previous
PAN-OS XML API Request Types and Actions
Next
Configuration Actions
