Use the API Browser

Each firewall and Panorama provides an API browser that is accessible from your web browser. The API browser lets you navigate through and view the corresponding XPath and API URL.
  1. Launch the web interface.
    1. Use a web browser to navigate to the actual FQDN or IP address of your firewall:
      https://<firewall>/
    2. Log in with your administrator credentials when prompted to log in to the web interface.
  2. Launch the API Browser.
    Go to the API browser URL on your firewall:
    https://<firewall>/api
  3. Drill-down to a request.
    When you first open the API browser, the available Request Types display.
    1. Select one of the request types to drill down to the next level of the XPath. Let’s start with Configuration Commands, which equates to type=report:
      apibrowser.png
    2. Drill down further until you select a request that you want to test.
  4. Test a request.
    1. Select the URL to then test that request in the browser.
      apibrowserreports.png
      The browser shows the resulting XML response in the browser:
      apibrowserreports-output.png
      Along with the URL, the API browser also provides the XPath as necessary, as shown here for a description of a predefined application:
      apibrowser-predefined-app.png

Related Documentation