API Authentication and Security

To use the API (XML or REST), you must enable API access for your administrators and get your API key. By default, the firewall and Panorama support API requests over HTTPS. To make API request over HTTP, you must configure an interface management profile.
To authenticate your API request to the firewall or Panorama, provide the API key in any of the following ways:
  • Use the custom HTTP header, X-PAN-KEY: <key> to include the API key in the HTTP header.
  • Include the API key as a query parameter in the HTTP request URL.
  • Use Basic Authentication to pass the admin credentials as username:password with Base64 encoding in an Authorization header field.
    Authorization: Basic amJPbLxpbw9UaTpXb3JrKjIwMDA=
    Code copied to clipboard
    Unable to copy due to lack of browser support.
You cannot use basic authentication when you Get Your API Key.
To enforce key rotation set an API key lifetime; you can also revoke all API keys to protect from accidental exposure.

Related Documentation