Make Your First API Call

Get Your API Key to make your first call to the PAN-OS XML API.
  1. Make a cURL call to get system information, which returns the IP address, hostname, and model of your firewall. Be sure to include the API key:
    curl -k 'https://<firewall>//api/?type=op&cmd=<show><system><info></info></system></show>&key=<apikey>'
    Code copied to clipboard
    Unable to copy due to lack of browser support.
  2. Confirm that the response to the above request looks similar to this:
    <response status="success"> 
    :  <result> 
    :    <system> 
    :      <hostname>firewall</hostname> 
    :      <ip-address>10.27.0.8</ip-address> 
    :      <netmask>255.255.254.0</netmask> 
    :      <default-gateway>10.27.0.1</default-gateway> 
          <is-dhcp>no</is-dhcp> 
          <ipv6-address>unknown</ipv6-address> 
          <ipv6-link-local-address>fe80::21b:17dd:dedf:c04a/64</ipv6-link-local-address> 
          <ipv6-default-gateway /> 
          <mac-address>00:1b:17:ff:c0:4a</mac-address> 
          <time>Wed Feb 10 13:03:32 2016</time> 
          <uptime>1 days, 19:35:51</uptime> 
          <devicename>firewall</devicename> 
          <family>3000</family> 
          <model>PA-3020</model> 
          <serial>001901000114</serial> 
          <sw-version>7.1.</sw-version> 
          <global-protect-client-package-version>2.0.0</global-protect-client-package-version> 
          <app-version>557-3138</app-version> 
          <app-release-date>2016/02/09  16:56:02</app-release-date> 
          <av-version>2261-2700</av-version> 
          <av-release-date>2016/02/09  15:26:53</av-release-date> 
          <threat-version>557-3138</threat-version> 
          <threat-release-date>2016/02/09  16:56:02</threat-release-date> 
          <wf-private-version>0</wf-private-version> 
          <wf-private-release-date>unknown</wf-private-release-date> 
          <url-db>paloaltonetworks</url-db> 
          <wildfire-version>27518-28208</wildfire-version> 
          <wildfire-release-date>2016/01/08  11:08:16</wildfire-release-date> 
          <url-filtering-version>2016.01.08.407</url-filtering-version> 
          <global-protect-datafile-version>1452328885</global-protect-datafile-version> 
          <global-protect-datafile-release-date>2016/01/09 08:41:25</global-protect-datafile-release-date> 
          <logdb-version>7.0.9</logdb-version> 
          <platform-family>3000</platform-family> 
          <vpn-disable-mode>off</vpn-disable-mode> 
          <multi-vsys>on</multi-vsys> 
          <operational-mode>normal</operational-mode> 
        </system> 
      </result> 
    </response> 
    Code copied to clipboard
    Unable to copy due to lack of browser support.

Related Documentation