Focus

PAN-OS® and Panorama™ API Usage Guide

Resource Methods and Query Parameters (REST API)

Table of Contents

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 , shared`for Objects only` , vsys , or panorama-pushed	required, valid values on the firewall: shared`for Objects only` , vsys valid values on Panorama: shared or device-group	required, valid values on the firewall: shared`for Objects only` , vsys valid values on Panorama: shared or device-group	required, valid values on the firewall: shared`for Objects only` , vsys valid values on Panorama: shared or device-group	required, valid values on the firewall: shared`for Objects only` , vsys valid values on Panorama: shared or device-group	required, valid values on the firewall: shared , vsys valid values on Panorama: shared or device-group
	vsys	required, if location is vsys or panorama-pushed	required, if location is vsys	required, if location is vsys	required, if location is vsys	required, if location is vsys	required, if location is vsys
	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 , bottom , before , after
	dst	—	—	—	—	—	required, when where is before or after
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.0/<resource URI>?location=location&output-format=json
Create	POST https://<firewall or Panorama IP>/restapi/v10.0/<resource URI>?location=location&name=name
Edit	PUT https://<firewall or Panorama IP>/restapi/v10.0/<resource URI>?location=location&name=name
Delete	DELETE https://<firewall or Panorama IP>/restapi/v10.0/<resource URI>?location=location&name=name
Rename	POST https://<firewall or Panorama IP>/restapi/v10.0/<resource URI>:rename?location=location&name=name &newname=newname
Move	POST https://<firewall or Panorama IP>/restapi/v10.0/<resource URI>:move?location=location&name=name &where=<move to> <move to> can be top, bottom, before &dst=<policy name>, after &dst=<policy name>

Access the PAN-OS REST API

PAN-OS REST API Request and Response Structure