PAN-OS® and Panorama™ API Guide

Commit

1. Use one of the following requests to commit a configuration:
   • Commit— Commit candidate changes to the firewall.

   
   						curl -X POST 'https://firewall/api?type=commit&cmd=<commit></commit>"
   					
   Code copied to clipboard
    
   Unable to copy due to lack of browser support.
   Copy

   • Force Commit—

   
   						curl -X POST 'https://firewall/api?type=commit&cmd=<commit><force></force></commit>"
   					
   Code copied to clipboard
    
   Unable to copy due to lack of browser support.
   Copy

   • Partial commit while excluding shared objects and device and network configuration—

   
   						curl -X POST 'https://firewall/api?type=commit&action=partial&cmd=<commit><partial><device-and-network>excluded</device-and-network><shared-object>excluded</shared-object></partial></commit>"
   					
   Code copied to clipboard
    
   Unable to copy due to lack of browser support.
   Copy

   • Partial commit admin-level changes— To commit admin-level changes on a firewall, include the administrator name in the request.

   
   						curl -X POST 'https://firewall/api?type=commit&action=partial&cmd=<commit><partial><admin><member>$admin-name</member></admin></partial></commit>"
   					
   Code copied to clipboard
    
   Unable to copy due to lack of browser support.
   Copy

   • Partial commit admin-level changes on a firewall or Panorama while excluding shared objects—Include the administrator name in the request. Replace the $admin-name Replace

   
   						curl -X POST 'https://firewall/api?type=commit&action=partial&cmd=<commit><partial><device-and-network>excluded</device-and-network><shared-object>excluded</shared-object><admin><member>socadmin</member></admin></partial></commit>"
   					
   Code copied to clipboard
    
   Unable to copy due to lack of browser support.
   Copy
2. Confirm that the XML response indicates that there were no changes to commit or that the changes are queued for commit:
   • No pending changes to commit:

     
     								<response status="success" code="19">
     									  <msg>There are no changes to commit.</msg></response>
     
     							

   • Pending changes:

     
     								<response status="success" code="19">
       <result>
         <msg>
           <line>Commit job enqueued with jobid 4</line>
         </msg>
         <job>4</job>
       </result>
     </response>
     
     							
3. Query the status of the job using the job ID:

   
   						curl -X POST 'https://firewall/api?type=op&cmd=<show><jobs><id>4</id></jobs></show>"
   					
   Code copied to clipboard
    
   Unable to copy due to lack of browser support.
   Copy
4. Confirm that the XML response details state the Configuration was committed successfully:

   
   						<response status="success">
     <result>
       <job>
         <tenq>2021/07/21 14:33:55</tenq>
         <tdeq>14:33:55</tdeq>
         <id>4</id>
         <user>admin</user>
         <type>Commit</type>
         <status>ACT</status>
         <queued>NO</queued>
         <stoppable>yes</stoppable>
         <result>PEND</result>
         <tfin/>
         <description/>
         <positionInQ>0</positionInQ>
         <progress>55</progress>
         <warnings>
           <line>Aggregate-ethernet interface ae1 has no member interfaces.</line>
         </warnings>
         <details/>
       </job>
     </result>
   </response>