PAN-OS XML API Components
Table of Contents
9.1 (EoL)
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)
-
- 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)
End-of-Life (EoL)
PAN-OS XML API Components
Use the PAN-OS XML API when you want to automate tasks
you need to perform, such as:
- Create, update, and modify firewall and Panorama configurations.
- Execute operational mode commands, such as restart the system or validate configurations.
- Retrieve reports.
- Manage users through User-ID.
- Update dynamic objects without having to modify or commit new configurations.
The PAN-OS XML API offers a number of components to automate
access and configuration of Palo Alto Networks firewalls and Panorama.
Feature | Description |
|---|---|
Full access to PAN-OS functionality | The PAN-OS XML API allows you to access
almost all of the functionality normally provided through the firewall
web interface and CLI. |
Secure authentication and access using API
key and admin roles | Use your administrative username and password
to generate an API key to authenticate API calls. Granular roles allow
you to grant API access to specific functionality including reports,
logs, and operational mode commands. |
Options to view XML syntax through API browser,
CLI and web interface debug mode | To explore all various functions of the
API, you can use the API browser through the firewall web interface.
You can also enable debug mode through the CLI to see the API equivalent
of CLI commands. |
-
Design your application to queue events and perform batch API updates instead of sending single event or mapping updates.
-
Limit the number of concurrent API calls to five. The suggested limit ensures that there is no performance impact to the firewall web interface as the management plane web server handles requests from both the API and the web interface. Limits may vary depending on the type of request. The limit may be higher depending on the length of time required for certain requests.
To learn about the PAN-OS REST API, see PAN-OS REST API.
To learn about changes to the latest version of CLI commands
that affect corresponding PAN-OS XML API requests, see the PAN-OS CLI Quick Start.