Resource Methods and Query Parameters (REST API)
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)
Resource Methods and Query Parameters (REST API)
The PAN-OS REST API requires query parameters for all
API requests. The following table describes the methods that the
PAN-OS REST API supports and includes the query parameters required
for each operation.
For a list of all resource URIs, see Access the PAN-OS REST API. To start
using the API, see Work With Objects (REST API) or Create a Security Policy Rule (REST API).
Resource Method | Read the list of resources | Create a resource | Modify a resource | Delete a resource | Rename a resource | Move a policy rule(Policies only) | |
HTTP Method | GET | POST | PUT | DELETE | POST | POST | |
Query Parameters | name | optional | required | required | required | required | required |
location | required, valid values on the firewall: , , , or
| required, valid values on the firewall: ,
valid values on Panorama: or
| required, valid values on the firewall: ,
valid values on Panorama: or
| required, valid values on the firewall: ,
valid values on Panorama: or
| required, valid values on the firewall: ,
valid values on Panorama: or
| required, valid values on the firewall: ,
valid
values on Panorama: or
| |
vsys | required, if location is or
| required, if location is
| required, if location is
| required, if location is
| required, if location is
| required, if location is
| |
device-group | (Panorama only) required, if location is device-group | (Panorama only) required, if location is device-group | (Panorama only) required, if location is device-group | (Panorama only) required, if location is device-group | (Panorama only) required, if location is device-group | (Panorama only) required, if location is device-group | |
input-format | — | optional, default format is JSON | optional, default format is JSON | — | — | — | |
output-format | optional, default format is JSON | optional, default format is JSON | optional, default format is JSON | optional, default format is JSON | optional, default format is JSON | optional, default format is JSON | |
newname | — | — | — | — | required | — | |
where | — | — | — | — | — | required, valid values: , , ,
| |
dst | — | — | — | — | — | required, when is or
| |
Request Body | — | required | required | — | — | — |
The following table shows examples of request formats with query
parameters.
Action | Example of Query Parameters in URL |
---|---|
List |
|
Create |
|
Edit |
|
Delete |
|
Rename |
|
Move |
<move
to> can be top, bottom, before &dst=<policy name>,
after &dst=<policy name> |