About the PAN-OS API
Table of Contents
Expand all | Collapse all
-
- 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)
-
- Asynchronous and Synchronous Requests to the PAN-OS XML API
- Run Operational Mode Commands (API)
- Apply User-ID Mapping and Populate Dynamic Groups (API)
- Get Version Info (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)
About the PAN-OS API
The PAN-OS® and Panorama™ API allows you to manage firewalls and
Panorama through a third-party service, application, or script.
The firewalls and Panorama support two types of API—XML API and
REST API.
The XML API uses a tree of XML nodes to map firewall or Panorama
functionality. To make an API request, you must specify the XPath (XML Path Language) to the XML node that
corresponds to a specific setting or action. XPath allows you to
navigate through the hierarchical XML tree structure for firewalls
and Panorama. To get started, see:
You can use the REST API to Create, Update, Read, Delete (CRUD)
Objects and Policies on the firewalls; you can access the REST API
directly on the firewall or use Panorama to perform these operation
on policies and objects from a central location and push them to
the managed firewalls. To get started, see Access the PAN-OS REST API.
Because PAN-OS API functionality mirrors that of both the web
interface and the CLI, you should familiarize yourself with both.
Reading relevant portions of the PAN-OS Administrator’s Guide will
help you get a better understanding of firewall functionalities
that you can access using the API. You should also be knowledgeable
about web service APIs, HTTP, XML, and XPath.