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 betop ,bottom ,before &dst=<policy name> ,
after &dst=<policy name> |
Most Popular
Recommended For You
Recommended Videos
Recommended videos not found.
