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
at
https://<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.2 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.2 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.2/Objects/Addresses |
/restapi/v10.2/Objects/AddressGroups | |
/restapi/v10.2/Objects/Regions | |
/restapi/v10.2/Objects/Applications | |
/restapi/v10.2/Objects/ApplicationGroups | |
/restapi/v10.2/Objects/ApplicationFilters | |
/restapi/v10.2/Objects/Services | |
/restapi/v10.2/Objects/ServiceGroups | |
/restapi/v10.2/Objects/Tags | |
/restapi/v10.2/Objects/GlobalProtectHIPObjects | |
/restapi/v10.2/Objects/GlobalProtectHIPProfiles | |
/restapi/v10.2/Objects/ExternalDynamicLists | |
/restapi/v10.2/Objects/CustomDataPatterns | |
/restapi/v10.2/Objects/CustomSpywareSignatures | |
/restapi/v10.2/Objects/CustomVulnerabilitySignatures | |
/restapi/v10.2/Objects/CustomURLCategories | |
/restapi/v10.2/Objects/AntivirusSecurityProfiles | |
/restapi/v10.2/Objects/AntiSpywareSecurityProfiles | |
/restapi/v10.2/Objects/VulnerabilityProtectionSecurityProfiles | |
/restapi/v10.2/Objects/URLFilteringSecurityProfiles | |
/restapi/v10.2/Objects/FileBlockingSecurityProfiles | |
/restapi/v10.2/Objects/WildFireAnalysisSecurityProfiles | |
/restapi/v10.2/Objects/DataFilteringSecurityProfiles | |
/restapi/v10.2/Objects/DoSProtectionSecurityProfiles | |
/restapi/v10.2/Objects/SecurityProfileGroups | |
/restapi/v10.2/Objects/LogForwardingProfiles | |
/restapi/v10.2/Objects/AuthenticationEnforcements | |
/restapi/v10.2/Objects/DecryptionProfiles | |
/restapi/v10.2/Objects/DecryptionForwardingProfiles | |
/restapi/v10.2/Objects/Schedules | |
/restapi/v10.2/Objects/SDWANPathQualityProfiles | |
/restapi/v10.2/Objects/SDWANTrafficDistributionProfiles | |
POLICIES | /restapi/v10.2/Policies/SecurityRules |
/restapi/v10.2/Policies/NATRules | |
/restapi/v10.2/Policies/QoSRules | |
/restapi/v10.2/Policies/PolicyBasedForwardingRules | |
/restapi/v10.2/Policies/DecryptionRules | |
/restapi/v10.2/Policies/TunnelInspectionRules | |
/restapi/v10.2/Policies/ApplicationOverrideRules | |
/restapi/v10.2/Policies/AuthenticationRules | |
/restapi/v10.2/Policies/DoSRules | |
/restapi/v10.2/Policies/SDWANRules | |
NETWORK | /restapi/v10.2/Network/EthernetInterfaces |
/restapi/v10.2/Network/AggregateEthernetInterfaces | |
/restapi/v10.2/Network/VLANInterfaces | |
/restapi/v10.2/Network/LoopbackInterfaces | |
/restapi/v10.2/Network/TunnelIntefaces | |
/restapi/v10.2/Network/SDWANInterfaces | |
/restapi/v10.2/Network/Zones | |
/restapi/v10.2/Network/VLANs | |
/restapi/v10.2/Network/VirtualWires | |
/restapi/v10.2/Network/VirtualRouters | |
/restapi/v10.2/Network/IPSecTunnels | |
/restapi/v10.2/Network/GRETunnels | |
/restapi/v10.2/Network/DHCPServers | |
/restapi/v10.2/Network/DHCPRelays | |
/restapi/v10.2/Network/DNSProxies | |
/restapi/v10.2/Network/GlobalProtectPortals | |
/restapi/v10.2/Network/GlobalProtectGateways | |
/restapi/v10.2/Network/GlobalProtectGatewayAgentTunnels | |
/restapi/v10.2/Network/GlobalProtectGatewaySatelliteTunnels | |
/restapi/v10.2/Network/GlobalProtectGatewayMDMServers | |
/restapi/v10.2/Network/GlobalProtectClientlessApps | |
/restapi/v10.2/Network/GlobalProtectClientlessAppGroups | |
/restapi/v10.2/Network/QoSInterfaces | |
/restapi/v10.2/Network/LLDP | |
/restapi/v10.2/Network/GlobalProtectIPSecCryptoNetworkProfiles | |
/restapi/v10.2/Network/IKEGatewayNetworkProfiles | |
/restapi/v10.2/Network/IKECryptoNetworkProfiles | |
/restapi/v10.2/Network/MonitorNetworkProfiles | |
/restapi/v10.2/Network/InterfaceManagementNetworkProfiles | |
/restapi/v10.2/Network/ZoneProtectionNetworkProfiles | |
/restapi/v10.2/Network/QoSNetworkProfiles | |
/restapi/v10.2/Network/LLDPNetworkProfiles | |
/restapi/v10.2/Network/SDWANInterfaceProfiles | |
Devices | /restapi/v10.2/Device/VirtualSystems |
Most Popular
Recommended For You
Recommended Videos
Recommended videos not found.
