Asynchronous and Synchronous Requests to the PAN-OS XML 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)
Asynchronous and Synchronous Requests to the PAN-OS XML API
Most PAN-OS XML API requests are synchronous, meaning
the response immediately provides the requested data. For example,
when you
Make
Your First API Call and request system information, the API
response is immediate and contains information such as the IP address,
hostname, and model of your firewall.
However, there are some
Request
Types that require more time to process and are asynchronous,
meaning they require more than one request to get final results.
These API requests include the following:
-
Some requests to Run Operational Mode Commands (API), including download, upgrade, and installation requests
With asynchronous requests, you first initiate a request. The
API responds with a job ID while it processes your request. In your
subsequent requests, you use this job ID to check on the results
of your original request.
Examples (replace
jobid with the
actual job ID):
-
Get reports:https://<firewall>/api/?key= apikey&type=report&action=get&job-id=jobidRetrieve logs:https://<firewall>/api/?key= apikey&type=log&action=get&job-id=jobidExport technical support data:https://<firewall>/api/?key= apikey&type=export&category=tech-support&action=get&job-id=jobidCommit:https://<firewall>/api/?key= apikey&type=commit&cmd=<commit></commit>Operational commands:https://<firewall>/api/?key= apikey&type=op&cmd=<show><jobs><id>jobid</id></jobs></show>