Home

Location

Documentation Home
Palo Alto Networks
Support
Live Community
Knowledge Base

Home
PAN-OS
PAN-OS® and Panorama™API Guide
PAN-OS XML API Request Types
PAN-OS XML API Request Types and Actions

Last Updated:

Nov 24, 2021

Current Version:

8.0 (EoL)

Version 10.2
Version 10.1
Version 10.0
Version 9.1
Version 9.0 (EoL)
Version 8.1 (EoL)
Version 8.0 (EoL)
Version 7.1 (EoL)

End-of-Life (EoL)

Table of Contents

Search the Table of Contents

About the PAN-OS XML API

PAN-OS XML API Components

Structure of a PAN-OS XML API Request

API Authentication and Security

XML and XPath

XPath Node Selection

Get Started with the PAN-OS XML API

Enable API Access

Get Your API Key

Make Your First API Call

Explore the API

Use the API Browser

Use the CLI to Find XML API Syntax

Use the Web Interface to Find XML API Syntax

PAN-OS XML API Error Codes

PAN-OS XML API Use Cases

Upgrade a Firewall to the Latest PAN-OS Version (API)

Show and Manage GlobalProtect Users (API)

Query a Firewall from Panorama (API)

Upgrade PAN-OS on Multiple HA Firewalls through Panorama (API)

Automatically Check for and Install Content Updates (API)

Enforce Policy using External Dynamic Lists and AutoFocus Artifacts (API)

Configure SAML 2.0 Authentication (API)

PAN-OS XML API Request Types

PAN-OS XML API Request Types and Actions

Request Types

Configuration Actions

Actions for Modifying a Configuration

Actions for Reading a Configuration

Asynchronous and Synchronous Requests to the PAN-OS XML API

Configuration (API)

Get Active Configuration

Use XPath to Get Active Configuration

Use XPath to Get ARP Information

Get Candidate Configuration

Set Configuration

Edit Configuration

Delete Configuration

Rename Configuration

Clone Configuration

Move Configuration

Override Configuration

Multi-Move or Multi-Clone Configuration

View Configuration Node Values for XPath

Commit Configuration (API)

Commit

Commit-All

Run Operational Mode Commands (API)

Get Reports (API)

Dynamic Reports

Predefined Reports

Custom Reports

Export Files (API)

Export Packet Captures

Export Application PCAPS

Export Threat, Filter, and Data Filtering PCAPs

Export Certificates and Keys

Export Technical Support Data

Import Files (API)

Importing Basics

Import Files

Retrieve Logs (API)

API Log Retrieval Parameters

Example: Use the API to Retrieve Traffic Logs

Apply User-ID Mapping and Populate Dynamic Address Groups (API)

Get Version Info (API)

About the PAN-OS XML API
- PAN-OS XML API Components
- Structure of a PAN-OS XML API Request
Get Started with the PAN-OS XML API
PAN-OS XML API Use Cases
PAN-OS XML API Request Types

Document:PAN-OS® and Panorama™API Guide

PAN-OS XML API Request Types and Actions

Last Updated:

Nov 24, 2021

Current Version:

8.0 (EoL)

Version 10.2
Version 10.1
Version 10.0
Version 9.1
Version 9.0 (EoL)
Version 8.1 (EoL)
Version 8.0 (EoL)
Version 7.1 (EoL)

End-of-Life (EoL)

PAN-OS XML API Request Types and Actions

Use PAN-OS XML API to run various requests depending on the request type that you specify:

Configuration Actions

Recommended For You

Recommended Videos

Recommended videos not found.

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