How to Export The Device State Using XML API

How to Export The Device State Using XML API

47252
Created On 09/25/18 19:48 PM - Last Modified 08/05/20 21:53 PM


Symptom


Palo Alto Networks XML API uses standard HTTP requests to send and receive data, allowing access to several types of data on the device. The data can then easily be integrated with and used in other systems. Using XML API you can also export the device state, which is used to backup a Palo Alto Networks firewall.

Resolution


Details
Proceed with the following steps:

  1. Get the API key, which is required for authenticating API calls. You can generate it per user by using: 
      https://<firewall-IP>/api/?type=keygen&user=<username>&password=<password>
    For more information, please refer to the admin guide: Get Your API Key .
  2. Export the device state from the firewall using: 
      https://<firewall-IP>/api/?type=export&category=device-state&key=<your_key>
    You will then be prompted to save the file.

What are the privileges needed to export the device state?

  • In 7.0 and earlier, a superuser as well as a custom-role based admin are able to export the device state.

  • Starting with 7.1, only a superuser has the privilege of performing an export of the device state. A custom-role based admin is treated as a device-admin. If you try to export the device state without superuser privileges, you will get the following error message: "You need superuser privileges to do that".

Additional Information
Other users also viewed:
Actions
  • Print
  • Copy Link

    https://knowledgebase.paloaltonetworks.com/KCSArticleDetail?id=kA10g000000CldVCAS&refURL=http%3A%2F%2Fknowledgebase.paloaltonetworks.com%2FKCSArticleDetail

Choose Language