Use the Web Interface to Find XML API Syntax
You can use the web interface along with the available debug console to explore the XML and XPath necessary for your API calls.
First log into the web interface and then open a separate window where you can view the corresponding XML and XPath.
- Launch the web interface.Launch a web browser and enter the firewall’s IP address or hostname. Enter your user credentials.
- Launch the debug console.In a separate web browser window or tab, launch the debug console:
http://<firewall>/debugCode copied to clipboardUnable to copy due to lack of browser support.
- Perform the action you want to replicate through the
API.In the web browser, navigate to the menu and item or action that you want to perform.To aid in finding the relevant XML, select Clear in the debug console just before you select the final menu or action.
- View the resulting XML syntax in the debug console.In the debug console, select Refresh and then navigate through the console to the syntax related to your choice or action:Example XML within debug console:
<request cmd="op" cookie="3885378180190727"> <operations xml="yes"> <show> <system> <info/> </system> </show> </operations> </request>Code copied to clipboardUnable to copy due to lack of browser support.The corresponding API call looks like this:
https://<firewall>/api/?type=op&cmd=<show><system><info></info></system></show>&key=<apikey>Code copied to clipboardUnable to copy due to lack of browser support.
Use the CLI to Find XML API Syntax
Use the CLI to Find XML API Syntax Another method to determine the appropriate XML syntax and XPath for your API calls is through the ...
Explore the API
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 ...
Use the API Browser
Use the API Browser Each firewall and Panorama provides an API browser that is accessible from your web browser. The API browser lets you navigate ...
PAN-OS XML API Components
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 ...
About the PAN-OS XML API
About the PAN-OS XML API The PAN-OS® and Panorama™ XML API allows you to manage firewalls and Panorama through a programmatic XML-based API. Use this ...
XML and XPath
XML and XPath The PAN-OS XML API uses XML for both requests and responses. When making requests, construct an HTTPS GET or POST request with ...
Launch the VM-Series Auto Scaling Template for AWS (v2.0)
Launch the VM-Series Auto Scaling Template for AWS (v2.0) You can choose to deploy the firewall template in one VPC and the sample application template ...
Access and Navigate Panorama Management Interfaces
Access and Navigate Panorama Management Interfaces Panorama provides three management interfaces: Web interface —The Panorama web interface has a look and feel similar to the ...
Management Interfaces You can use the following user interfaces to manage the Palo Alto Networks firewall: Do not enable management access from the internet or ...