1. Home
    2. PAN-OS
    3. PAN-OS® and Panorama™API Guide
    4. PAN-OS XML API Request Types
    5. Configuration (API)
    6. Get Candidate Configuration
    End-of-Life (EoL)

    Get Candidate Configuration

    Get the candidate configuration from a firewall by specifying the portion of the configuration to get. Use the following request, including the
    xpath
     parameter to specify the portion of the configuration to get.
    https://
    <firewall>
    /api/?type=config&action=get&xpath=
    <path-to-config-node>
    Configuration Node
    API Request
    Firewall candidate configuration
    https://
    <firewall>
    /api/?type=config&action=get&xpath=/config/devices/entry/vsys/entry[@name='vsys1']&key=
    <api_key>
    Firewall candidate configuration through Panorama
    https://<panorama>/api/?type=config&action=get&xpath=/config/devices/entry/vsys/entry[@name='vsys1']&target=<serial>&key=
    <panorama_api_key>
    Firewall candidate configuration through Panorama without specifying a firewall
    https://<panorama>/api/?type=config&action=get&xpath=/config/devices/entry/*[name()!='vsys']|/config/devices/entry/vsys/entry[@name='vsys1']&key=
    <panorama_api_key>
    Address objects in a virtual system (vsys).
    https://
    <firewall>
    //api/?type=config&action=get&xpath=/config/devices/entry/vsys/entry[@name='vsys1']/address
    The response looks similar to the following:
    <response
status="success" code="19"> 
    <result total-count="1" count="1"> 
        <address admin="name" dirtyId="8" time="2015/10/20
15:32:36"> 
            <entry name="testobject"> 
                <ip-netmask>192.0.2.2</ip-netmask> 
            </entry> 
            <entry name="test1"> 
                <ip-netmask>192.0.2.12</ip-netmask> 
            </entry> 
... 
        </address> 
    </result> 
</response>
    Pre-rules pushed from Panorama.
    https://
    <firewall>
    //api/?type=config&action=get&xpath=/config/panorama/vsys/entry[@name='vsys']/pre-rulebase/security
    Full list of all applications.
    https://
    <firewall>
    /api/?type=config&action=get&xpath=/config/predefined/application
    Details on the specific application.
    https://
    <firewall>
    /api/?type=config&action=get&xpath=/config/predefined/application/entry[@name='hotmail']

    Recommended For You

    Recommended Videos

    Recommended videos not found.

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

    Techdocs Logo