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.

Related Documentation