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:
predefined
Code copied to clipboard
Unable to copy due to lack of browser support.
,
shared
for Objects only
Code copied to clipboard
Unable to copy due to lack of browser support.
,
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
, or
panorama-pushed
Code copied to clipboard
Unable to copy due to lack of browser support.
required,
valid values on the firewall:
shared
for Objects only
Code copied to clipboard
Unable to copy due to lack of browser support.
,
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
valid values on Panorama:
shared
Code copied to clipboard
Unable to copy due to lack of browser support.
or
device-group
Code copied to clipboard
Unable to copy due to lack of browser support.
required,
valid values on the firewall:
shared
for Objects only
Code copied to clipboard
Unable to copy due to lack of browser support.
,
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
valid values on Panorama:
shared
Code copied to clipboard
Unable to copy due to lack of browser support.
or
device-group
Code copied to clipboard
Unable to copy due to lack of browser support.
required,
valid values on the firewall:
shared
for Objects only
Code copied to clipboard
Unable to copy due to lack of browser support.
,
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
valid values on Panorama:
shared
Code copied to clipboard
Unable to copy due to lack of browser support.
or
device-group
Code copied to clipboard
Unable to copy due to lack of browser support.
required,
valid values on the firewall:
shared
for Objects only
Code copied to clipboard
Unable to copy due to lack of browser support.
,
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
valid values on Panorama:
shared
Code copied to clipboard
Unable to copy due to lack of browser support.
or
device-group
Code copied to clipboard
Unable to copy due to lack of browser support.
required,
valid values on the firewall:
shared
Code copied to clipboard
Unable to copy due to lack of browser support.
,
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
valid values on Panorama:
shared
Code copied to clipboard
Unable to copy due to lack of browser support.
or
device-group
Code copied to clipboard
Unable to copy due to lack of browser support.
vsys
required, if location is
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
or
panorama-pushed
Code copied to clipboard
Unable to copy due to lack of browser support.
required, if location is
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
required, if location is
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
required, if location is
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
required, if location is
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
required, if location is
vsys
Code copied to clipboard
Unable to copy due to lack of browser support.
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:
top
Code copied to clipboard
Unable to copy due to lack of browser support.
,
bottom
Code copied to clipboard
Unable to copy due to lack of browser support.
,
before
Code copied to clipboard
Unable to copy due to lack of browser support.
,
after
Code copied to clipboard
Unable to copy due to lack of browser support.
dest
required, when
where
Code copied to clipboard
Unable to copy due to lack of browser support.
is
before
Code copied to clipboard
Unable to copy due to lack of browser support.
or
after
Code copied to clipboard
Unable to copy due to lack of browser support.
Request Body
required
required
The following table shows examples of request formats with query parameters.
Action
Example of Query Parameters in URL
List
GET https://<firewall or Panorama IP>/restapi/v10.1/<resource URI>?location=location&output-format=json
Code copied to clipboard
Unable to copy due to lack of browser support.
Create
POST https://<firewall or Panorama IP>/restapi/v10.1/<resource URI>?location=location&name=name
Code copied to clipboard
Unable to copy due to lack of browser support.
Edit
PUT https://<firewall or Panorama IP>/restapi/v10.1/<resource URI>?location=location&name=name
Code copied to clipboard
Unable to copy due to lack of browser support.
Delete
DELETE https://<firewall or Panorama IP>/restapi/v10.1/<resource URI>?location=location&name=name
Code copied to clipboard
Unable to copy due to lack of browser support.
Rename
POST https://<firewall or Panorama IP>/restapi/v10.1/<resource URI>:rename?location=location&name=name &newname=newname
Code copied to clipboard
Unable to copy due to lack of browser support.
Move
POST https://<firewall or Panorama IP>/restapi/v10.1/<resource URI>:move?location=location&name=name &where=<move to>
Code copied to clipboard
Unable to copy due to lack of browser support.
<move to>
can be
top
,
bottom
,
before &dest=<policy name>
, after &dest=<policy name>

Recommended For You