PAN-OS® and Panorama™API Usage Guide
    : Enable API Access
    Focus
    Download PDF
    Focus
    1. Home
    2. PAN-OS
    3. PAN-OS® and Panorama™API Usage Guide
    4. Get Started with the PAN-OS XML API
    5. Enable API Access
    Download PDF

    PAN-OS® and Panorama™API Usage Guide

    Enable API Access

    Table of Contents

    Enable API Access

    The API supports the following types of Administrators and Admin roles:
    • Dynamic roles: Superuser, Superuser (readonly), Device admin, Device admin (readonly), Vsys admin, Vsys admin (readonly)
    • Role-based Admins: Device, Vsys, Panorama.
    Admin Role profiles enable or disable features on the management interfaces of the firewall or Panorama, XML API, web interface, and CLI. For more details on Administrative Roles, see Configure an Admin Role Profile.
    As a best practice, set up a separate admin account for XML API access.
    1. Select an Admin Role profile.
      Go to DeviceAdmin Roles and select or create an admin role.
    2. Select features available to the admin role.
      1. Select the XML API tab.
      2. Enable or disable XML API features from the list, such as Report, Log, and Configuration.
      3. Select OK to confirm your change.
    3. Assign the admin role to an administrator account.
      See Configure an Administrative Account.

    © 2024 Palo Alto Networks, Inc. All rights reserved.