Access the PAN-OS REST API
Table of Contents
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)
- Quarantine Compromised Devices (API)
- Manage Certificates (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)
- Configure an Ethernet Interface (REST API)
- Update a Virtual Router (REST API)
- Work With Decryption (APIs)
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 10.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
10.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/v10.1/Objects/Addresses |
/restapi/v10.1/Objects/AddressGroups | |
/restapi/v10.1/Objects/Regions | |
/restapi/v10.1/Objects/Applications | |
/restapi/v10.1/Objects/ApplicationGroups | |
/restapi/v10.1/Objects/ApplicationFilters | |
/restapi/v10.1/Objects/Services | |
/restapi/v10.1/Objects/ServiceGroups | |
/restapi/v10.1/Objects/Tags | |
/restapi/v10.1/Objects/GlobalProtectHIPObjects | |
/restapi/v10.1/Objects/GlobalProtectHIPProfiles | |
/restapi/v10.1/Objects/ExternalDynamicLists | |
/restapi/v10.1/Objects/CustomDataPatterns | |
/restapi/v10.1/Objects/CustomSpywareSignatures | |
/restapi/v10.1/Objects/CustomVulnerabilitySignatures | |
/restapi/v10.1/Objects/CustomURLCategories | |
/restapi/v10.1/Objects/AntivirusSecurityProfiles | |
/restapi/v10.1/Objects/AntiSpywareSecurityProfiles | |
/restapi/v10.1/Objects/VulnerabilityProtectionSecurityProfiles | |
/restapi/v10.1/Objects/URLFilteringSecurityProfiles | |
/restapi/v10.1/Objects/FileBlockingSecurityProfiles | |
/restapi/v10.1/Objects/WildFireAnalysisSecurityProfiles | |
/restapi/v10.1/Objects/DataFilteringSecurityProfiles | |
/restapi/v10.1/Objects/DoSProtectionSecurityProfiles | |
/restapi/v10.1/Objects/SecurityProfileGroups | |
/restapi/v10.1/Objects/LogForwardingProfiles | |
/restapi/v10.1/Objects/AuthenticationEnforcements | |
/restapi/v10.1/Objects/DecryptionProfiles | |
/restapi/v10.1/Objects/DecryptionForwardingProfiles | |
/restapi/v10.1/Objects/Schedules | |
/restapi/v10.1/Objects/SDWANPathQualityProfiles | |
/restapi/v10.1/Objects/SDWANTrafficDistributionProfiles | |
POLICIES | /restapi/v10.1/Policies/SecurityRules |
/restapi/v10.1/Policies/NATRules | |
/restapi/v10.1/Policies/QoSRules | |
/restapi/v10.1/Policies/PolicyBasedForwardingRules | |
/restapi/v10.1/Policies/DecryptionRules | |
/restapi/v10.1/Policies/TunnelInspectionRules | |
/restapi/v10.1/Policies/ApplicationOverrideRules | |
/restapi/v10.1/Policies/AuthenticationRules | |
/restapi/v10.1/Policies/DoSRules | |
/restapi/v10.1/Policies/SDWANRules | |
NETWORK | /restapi/v10.1/Network/EthernetInterfaces |
/restapi/v10.1/Network/AggregateEthernetInterfaces | |
/restapi/v10.1/Network/VLANInterfaces | |
/restapi/v10.1/Network/LoopbackInterfaces | |
/restapi/v10.1/Network/TunnelIntefaces | |
/restapi/v10.1/Network/SDWANInterfaces | |
/restapi/v10.1/Network/Zones | |
/restapi/v10.1/Network/VLANs | |
/restapi/v10.1/Network/VirtualWires | |
/restapi/v10.1/Network/VirtualRouters | |
/restapi/v10.1/Network/IPSecTunnels | |
/restapi/v10.1/Network/GRETunnels | |
/restapi/v10.1/Network/DHCPServers | |
/restapi/v10.1/Network/DHCPRelays | |
/restapi/v10.1/Network/DNSProxies | |
/restapi/v10.1/Network/GlobalProtectPortals | |
/restapi/v10.1/Network/GlobalProtectGateways | |
/restapi/v10.1/Network/GlobalProtectGatewayAgentTunnels | |
/restapi/v10.1/Network/GlobalProtectGatewaySatelliteTunnels | |
/restapi/v10.1/Network/GlobalProtectGatewayMDMServers | |
/restapi/v10.1/Network/GlobalProtectClientlessApps | |
/restapi/v10.1/Network/GlobalProtectClientlessAppGroups | |
/restapi/v10.1/Network/QoSInterfaces | |
/restapi/v10.1/Network/LLDP | |
/restapi/v10.1/Network/GlobalProtectIPSecCryptoNetworkProfiles | |
/restapi/v10.1/Network/IKEGatewayNetworkProfiles | |
/restapi/v10.1/Network/IKECryptoNetworkProfiles | |
/restapi/v10.1/Network/MonitorNetworkProfiles | |
/restapi/v10.1/Network/InterfaceManagementNetworkProfiles | |
/restapi/v10.1/Network/ZoneProtectionNetworkProfiles | |
/restapi/v10.1/Network/QoSNetworkProfiles | |
/restapi/v10.1/Network/LLDPNetworkProfiles | |
/restapi/v10.1/Network/SDWANInterfaceProfiles | |
Devices | /restapi/v10.1/Device/VirtualSystems |