Home
Products
Releases
Best Practices
Resources
By Type
EN
Location
Documentation Home
Palo Alto Networks
Support
Live Community
Knowledge Base
Products
Releases
Best Practices
Resources
By Type
Network Security
Cloud-Delivered Security Services
Advanced DNS Security
Advanced WildFire
Advanced Threat Prevention
Advanced URL Filtering
AI Access Security
Enterprise Data Loss Prevention
SaaS Security
IoT Security
Cloud Identity Engine
Cloud NGFW for AWS
Cloud NGFW for Azure
CN-Series
Common Services
License Activation & Subscription Management
Tenant Management
Identity & Access Management
Device Associations
FAQ
GlobalProtect
Next-Generation Firewall
PAN-OS
AIOps for NGFW
Firewalls
SD-WAN
Service Provider
Panorama
Strata Logging Service
Strata Cloud Manager
AI Runtime Security
VM-Series
Secure Access Service Edge
Common Services
License Activation & Subscription Management
Tenant Management
Identity & Access Management
Device Associations
FAQ
FedRAMP
Next-Generation CASB
Prisma Access
Autonomous DEM
Prisma Access Browser
Prisma SD-WAN
ION Devices
Remote Browser Isolation
Strata Cloud Manager
Strata Multitenant Cloud Manager
Cloud-Native Security
Prisma Cloud
Security Operations
Cortex XDR
Cortex XSOAR
Cortex XPANSE
Cortex XSIAM
What's New
What's New Releases
All Release Notes
View All Release Notes
Recently Updated Release Notes
PAN-OS Release Notes (PAN-OS 11.1)
PAN-OS Release Notes (PAN-OS 11.2)
VM-Series and Panorama Plugins Release Notes
AI Runtime Security Release Notes
SaaS Security Release Notes
Release Notes
PAN-OS Release Notes (PAN-OS 10.2)
Release Notes
Strata Cloud Manager Release Notes
Cloud Identity Engine Release Notes
See All Recently Updated Release Notes
Recently Updated Documentation
Prisma Access Integrations
Prisma Access Release Notes (5.2 Preferred and Innovation)
Prisma Access Release Notes (5.1 Preferred and Innovation)
Prisma Access Release Notes (5.0 Preferred and Innovation)
WildFire Appliance Administration
SSPM Administration
Strata Cloud Manager Activation & Onboarding
Strata Cloud Manager Getting Started
Prisma SD-WAN ION Device Release Notes (6.1)
Prisma SD-WAN ION Device Release Notes (6.2)
See All Recent Updates
Applications and Threats Content Updates
Best Practices for Migrating to Application-Based Policy
Data Center
Decryption
DoS and Zone
Get Started
Internet Gateway Security Policy
Secure Administrative Access
Security Policy
WildFire
Zero Trust
VIEW ALL
All Release Notes
Blog
Compatibility Matrix
Experts Corner
Infographics
Licensing, Registration, and Activation
OSS Listings
Translated Documents
VIEW ALL
API Documentation
Release Notes
PAN-OS® and Panorama™API Usage Guide
PAN-OS® and Panorama™API Usage Guide
All PAN-OS Documentation
All Documentation
Clear
Search
Loading
Clear
PAN-OS® and Panorama™API Usage Guide
:
Explore the API
Updated on
Mon Aug 26 17:59:03 UTC 2024
Focus
Download PDF
Updated on
Mon Aug 26 17:59:03 UTC 2024
Focus
Home
PAN-OS
PAN-OS® and Panorama™API Usage Guide
Get Started with the PAN-OS XML API
Explore the API
Download PDF
PAN-OS® and Panorama™API Usage Guide
Explore the API
Table of Contents
Filter
Version
PAN.OS 11.1 & Later
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
PAN-OS API Authentication
Enable API Access
Get Your API Key
Generate an API Key Certificate
Authenticate Your API Requests
Get Started with the PAN-OS XML API
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)
Explore the API
There are several ways you can explore the API and learn how to construct your XML requests:
Use the API Browser
Use the CLI to Find XML API Syntax
Use the Web Interface to Find XML API Syntax
Previous
Make Your First API Call
Next
Use the API Browser
x
Thanks for visiting
https://docs.paloaltonetworks.com
. To improve your experience when accessing content across our site, please add the domain to the allow list on your ad blocker application.
