Palo Alto Networks

Palo Alto Networks Commit API

Configuration commit operations.

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /Commit Check the status of a firewall commit · Palo Alto Networks Get Commit Job Status #
Ask an LLM
“Has my firewall commit finished, and did it succeed?”
“How can I track the progress of a commit using its job ID?”
Tell an agent
Check the status of commit job {jobid}.
Poll commit job {jobid} until it completes.
POST /Commit Commit candidate configuration to the firewall · Palo Alto Networks Commit Configuration #
Ask an LLM
“How do I apply my staged configuration changes to the running firewall config?”
“Can I do a partial commit for specific admins, device groups or vsys?”
Tell an agent
Commit the candidate configuration to the firewall.
Run a commit with command {cmd}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-commit-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/palo-alto-networks:palo-alto-networks-commit-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

palo-alto-networks-commit-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Palo Alto Networks PAN-OS REST Commit API
  description: RESTful API for managing Palo Alto Networks PAN-OS next-generation firewalls.
  version: '10.2'
  contact:
    name: Palo Alto Networks Developer Support
    url: https://pan.dev/pan-os/docs/restapi/
  license:
    name: Proprietary
    url: https://www.paloaltonetworks.com/legal
servers:
- url: https://{firewall}/restapi/v10.2
  description: PAN-OS firewall or Panorama REST API endpoint.
  variables:
    firewall:
      description: Hostname or IP address of the PAN-OS firewall or Panorama appliance.
      default: firewall.example.com
security:
- apiKey: []
tags:
- name: Commit
  description: Configuration commit operations.
paths:
  /Commit:
    get:
      operationId: getCommitStatus
      summary: Palo Alto Networks Get Commit Job Status
      description: Returns the status of a commit operation by job ID. Poll this endpoint to monitor the progress of a commit job initiated via POST /Commit.
      tags:
      - Commit
      parameters:
      - name: jobid
        in: query
        required: true
        description: Job ID returned by the commit operation.
        schema:
          type: string
        example: '327342'
      responses:
        '200':
          description: Commit job status returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitStatus'
              examples:
                GetCommitStatus200Example:
                  summary: Default getCommitStatus 200 response
                  x-microcks-default: true
                  value:
                    '@status': active
                    '@code': example-@code
                    result:
                      job:
                        id: example-id
                        type: advanced
                        status: WARN
                        result: OK
                        progress: example-progress
                        details:
                          line: example-line
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: commitConfiguration
      summary: Palo Alto Networks Commit Configuration
      description: Commits the current candidate configuration to the running configuration on the firewall. This operation applies all staged configuration changes. Returns a job ID that can be polled to track commit progress. Optionally specify a description and partial commit criteria (admin, device groups, vsys).
      tags:
      - Commit
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                cmd:
                  type: object
                  properties:
                    commit:
                      type: object
                      properties:
                        description:
                          type: string
                          description: Description for this commit.
                        partial:
                          type: object
                          description: Partial commit options.
                          properties:
                            admin:
                              type: object
                              properties:
                                member:
                                  type: array
                                  items:
                                    type: string
                                  description: Admin accounts to include in partial commit.
            examples:
              CommitConfigurationRequestExample:
                summary: Default commitConfiguration request
                x-microcks-default: true
                value:
                  cmd:
                    commit:
                      description: Incident violation policy alert monitoring investigation rule policy on incident.
                      partial:
                        admin:
                          member:
                          - example-member_item
                          - example-member_item
      responses:
        '200':
          description: Commit job initiated successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  '@status':
                    type: string
                  '@code':
                    type: string
                  result:
                    type: object
                    properties:
                      msg:
                        type: string
                      job:
                        type: string
                        description: Job ID to poll for commit status.
              examples:
                CommitConfiguration200Example:
                  summary: Default commitConfiguration 200 response
                  x-microcks-default: true
                  value:
                    '@status': enabled
                    '@code': example-@code
                    result:
                      msg: example-msg
                      job: example-job
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Malformed request or invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    CommitStatus:
      type: object
      description: Status of a commit job.
      properties:
        '@status':
          type: string
          example: active
        '@code':
          type: string
          example: example-@code
        result:
          type: object
          properties:
            job:
              type: object
              properties:
                id:
                  type: string
                  example: example-id
                type:
                  type: string
                  example: custom
                status:
                  type: string
                  enum:
                  - ACT
                  - PEND
                  - FIN
                  - WARN
                  example: PEND
                result:
                  type: string
                  enum:
                  - OK
                  - FAIL
                  - WARN
                  example: WARN
                progress:
                  type: string
                  description: Commit progress percentage (0-100).
                  example: example-progress
                details:
                  type: object
                  properties:
                    line:
                      oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
                      example: example-line
                  example:
                    line: example-line
              example:
                id: example-id
                type: standard
                status: ACT
                result: FAIL
                progress: example-progress
                details:
                  line: example-line
          example:
            job:
              id: example-id
              type: advanced
              status: WARN
              result: OK
              progress: example-progress
              details:
                line: example-line
    ErrorResponse:
      type: object
      properties:
        '@status':
          type: string
          example: running
        '@code':
          type: string
          example: example-@code
        msg:
          type: object
          properties:
            line:
              type: string
              description: Error message detail.
              example: example-line
          example:
            line: example-line
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-PAN-KEY
      description: PAN-OS API key generated via the /api/?type=keygen endpoint or from the web interface under Device > Administrators. The key is tied to an administrator account and inherits its role-based permissions.