Focus

PAN-OS® and Panorama™API Usage Guide

Access the PAN-OS REST API

Table of Contents

Access the PAN-OS REST API

The PAN-OS REST API URL format includes a base path and the URI for the endpoint.

curl -X GET "https://<IP address or FQDN>/restapi/<PAN-OS version>/<resource URI>", where:

The base path includes the FQDN or IP address of the firewall or Panorama and the version. The resource URI is the path for the resource or endpoint you want to work with, and it corresponds with the resources you can access on the web interface. Use the PAN-OS Web Interface Help to familiarize yourself with the field properties, descriptions, and supported values for each resource.

You can view the full list of resources in the REST API Reference on the firewall or Panorama athttps://<IP_address>/restapi-doc .

To use the REST API, you must Enable API Access for your administrators and Get Your API Key. See API Authentication and Security for details on authenticating your API requests.

The following table lists the PAN-OS 11.1 REST API resource URIs that are available on the firewall. The resource URIs on Panorama are analogous except that resources support both pre rule and post rule policies. The PAN-OS 11.1 REST API resources offer abilities like managing policies on the firewall or configuring SD-WAN interfaces and policies on Panorama. To complete the configuration, you’ll need to use the XML API on the firewall and Panorama.

Resource	URI
OBJECTS	/restapi/v11.0/Objects/Addresses
	/restapi/v11.0/Objects/AddressGroups
	/restapi/v11.0/Objects/Regions
	/restapi/v11.0/Objects/DynamicUserGroups
	/restapi/v11.0/Objects/Applications
	/restapi/v11.0/Objects/ApplicationGroups
	/restapi/v11.0/Objects/ApplicationFilters
	/restapi/v11.0/Objects/Services
	/restapi/v11.0/Objects/ServiceGroups
	/restapi/v11.0/Objects/Tags
	/restapi/v11.0/Objects/GlobalProtectHIPObjects
	/restapi/v11.0/Objects/GlobalProtectHIPProfiles
	/restapi/v11.0/Objects/ExternalDynamicLists
	/restapi/v11.0/Objects/CustomDataPatterns
	/restapi/v11.0/Objects/CustomSpywareSignatures
	/restapi/v11.0/Objects/CustomVulnerabilitySignatures
	/restapi/v11.0/Objects/CustomURLCategories
	/restapi/v11.0/Objects/AntivirusSecurityProfiles
	/restapi/v11.0/Objects/AntiSpywareSecurityProfiles
	/restapi/v11.0/Objects/VulnerabilityProtectionSecurityProfiles
	/restapi/v11.0/Objects/URLFilteringSecurityProfiles
	/restapi/v11.0/Objects/FileBlockingSecurityProfiles
	/restapi/v11.0/Objects/WildFireAnalysisSecurityProfiles
	/restapi/v11.0/Objects/DataFilteringSecurityProfiles
	/restapi/v11.0/Objects/DoSProtectionSecurityProfiles
	/restapi/v11.0/Objects/SecurityProfileGroups
	/restapi/v11.0/Objects/LogForwardingProfiles
	/restapi/v11.0/Objects/AuthenticationEnforcements
	/restapi/v11.0/Objects/DecryptionProfiles
	/restapi/v11.0/Objects/PacketBrokerProfiles
	/restapi/v11.0/Objects/SDWANPathQualityProfiles
	/restapi/v11.0/Objects/SDWANTrafficDistributionProfiles
/restapi/v11.0/Objects/SDWANSaasQualityProfiles
/restapi/v11.0/Objects/SDWANErrorCorrection
/restapi/v11.0/Objects/Schedules
POLICIES	/restapi/v11.0/Policies/SecurityRules
	/restapi/v11.0/Policies/NATRules
	/restapi/v11.0/Policies/QoSRules
	/restapi/v11.0/Policies/PolicyBasedForwardingRules
	/restapi/v11.0/Policies/DecryptionRules
	/restapi/v11.0/Policies/NetworkPacketBrokerRules
	/restapi/v11.0/Policies/TunnelInspectionRules
	/restapi/v11.0/Policies/ApplicationOverrideRules
	/restapi/v11.0/Policies/AuthenticationRules
	/restapi/v11.0/Policies/DoSRules
/restapi/v11.0/Policies/SDWANRules
NETWORK	/restapi/v11.0/Network/EthernetInterfaces
	/restapi/v11.0/Network/AggregateEthernetInterfaces
	/restapi/v11.0/Network/VLANInterfaces
	/restapi/v11.0/Network/LoopbackInterfaces
	/restapi/v11.0/Network/TunnelIntefaces
	/restapi/v11.0/Network/SDWANInterfaces
	/restapi/v11.0/Network/Zones
	/restapi/v11.0/Network/VLANs
	/restapi/v11.0/Network/VirtualWires
	/restapi/v11.0/Network/VirtualRouters
	/restapi/v11.0/Network/IPSecTunnels
	/restapi/v11.0/Network/GRETunnels
	/restapi/v11.0/Network/DHCPServers
	/restapi/v11.0/Network/DHCPRelays
	/restapi/v11.0/Network/DNSProxies
	/restapi/v11.0/Network/GlobalProtectPortals
	/restapi/v11.0/Network/GlobalProtectGateways
	/restapi/v11.0/Network/GlobalProtectGatewayAgentTunnels
	/restapi/v11.0/Network/GlobalProtectGatewaySatelliteTunnels
	/restapi/v11.0/Network/GlobalProtectGatewayMDMServers
	/restapi/v11.0/Network/GlobalProtectClientlessApps
	/restapi/v11.0/Network/GlobalProtectClientlessAppGroups
	/restapi/v11.0/Network/QoSInterfaces
	/restapi/v11.0/Network/LLDP
	/restapi/v11.0/Network/GlobalProtectIPSecCryptoNetworkProfiles
	/restapi/v11.0/Network/IKEGatewayNetworkProfiles
	/restapi/v11.0/Network/IKECryptoNetworkProfiles
	/restapi/v11.0/Network/MonitorNetworkProfiles
	/restapi/v11.0/Network/InterfaceManagementNetworkProfiles
	/restapi/v11.0/Network/ZoneProtectionNetworkProfiles
	/restapi/v11.0/Network/QoSNetworkProfiles
	/restapi/v11.0/Network/LLDPNetworkProfiles
	/restapi/v11.0/Network/BFDNetworkProfiles
/restapi/v11.0/Network/SDWANInterfaceProfiles
Devices	/restapi/v11.0/Device/VirtualSystems
/restapi/v11.0/Network/SNMPTrapServerProfiles
/restapi/v11.0/Network/SyslogServerProfiles
/restapi/v11.0/Network/EmailServerProfiles
/restapi/v11.0/Network/HttpServerProfiles
/restapi/v11.0/Network/LDAPServerProfiles

PAN-OS REST API

Resource Methods and Query Parameters (REST API)