Palo Alto Networks

Palo Alto Networks Onboarding API

Remote network onboarding status.

GitHub OpenAPI

Operations 1

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 /onboarding-status/{id} Check remote network onboarding status · Palo Alto Networks Get Remote Network Onboarding Status #
Ask an LLM
“Has my new remote network finished provisioning and brought its tunnel up?”
“Did the configuration push for a remote network succeed?”
Tell an agent
Get the onboarding status of remote network {id}.
Check whether remote network {id} tunnel is established.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/palo-alto-networks/openapi/palo-alto-networks-onboarding-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-onboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Palo Alto Networks SASE Configuration Orchestration…
  description: SASE Configuration Orchestration API for third-party SD-WAN integration.
  version: '1.0'
  contact:
    name: Palo Alto Networks Developer Support
    url: https://pan.dev/
  license:
    name: Proprietary
    url: https://www.paloaltonetworks.com/legal
servers:
- url: https://api.sase.paloaltonetworks.com/config-orchestration/v1
  description: SASE Configuration Orchestration API production server.
security:
- oauth2Bearer: []
tags:
- name: Onboarding
  description: Remote network onboarding status.
paths:
  /onboarding-status/{id}:
    get:
      operationId: getOnboardingStatus
      summary: Palo Alto Networks Get Remote Network Onboarding Status
      description: Returns the onboarding status for a remote network including provisioning progress, configuration push status, and tunnel establishment state. Use this endpoint to monitor the lifecycle of a newly created remote network.
      tags:
      - Onboarding
      parameters:
      - name: id
        in: path
        required: true
        description: Unique identifier of the remote network.
        schema:
          type: string
        example: example-id
      responses:
        '200':
          description: Onboarding status returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingStatus'
              examples:
                GetOnboardingStatus200Example:
                  summary: Default getOnboardingStatus 200 response
                  x-microcks-default: true
                  value:
                    id: example-id
                    status: failed
                    steps:
                    - step: example-step
                      status: completed
                      message: Network traffic suspicious violation malware alert.
                      completed_at: '2026-10-13T10:26:35Z'
                    error_message: example-error_message
                    started_at: '2024-02-24T21:09:42Z'
                    completed_at: '2024-04-28T11:33:26Z'
        '401':
          description: Invalid or missing Bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GetOnboardingStatus401Example:
                  summary: Default getOnboardingStatus 401 response
                  x-microcks-default: true
                  value:
                    error: example-error
                    message: Configured activity investigation policy detected violation blocked.
                    request_id: 3ab20120-828b-4af3-9110-53521ee47614
        '403':
          description: Insufficient permissions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GetOnboardingStatus403Example:
                  summary: Default getOnboardingStatus 403 response
                  x-microcks-default: true
                  value:
                    error: example-error
                    message: Configured activity investigation policy detected violation blocked.
                    request_id: 3ab20120-828b-4af3-9110-53521ee47614
        '404':
          description: Remote network not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GetOnboardingStatus404Example:
                  summary: Default getOnboardingStatus 404 response
                  x-microcks-default: true
                  value:
                    error: example-error
                    message: Configured activity investigation policy detected violation blocked.
                    request_id: 3ab20120-828b-4af3-9110-53521ee47614
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                GetOnboardingStatus500Example:
                  summary: Default getOnboardingStatus 500 response
                  x-microcks-default: true
                  value:
                    error: example-error
                    message: Configured activity investigation policy detected violation blocked.
                    request_id: 3ab20120-828b-4af3-9110-53521ee47614
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    OnboardingStatus:
      type: object
      properties:
        id:
          type: string
          description: Remote network identifier.
          example: example-id
        status:
          type: string
          enum:
          - pending
          - provisioning
          - configuring
          - tunnel_establishing
          - completed
          - failed
          description: Current onboarding phase.
          example: failed
        steps:
          type: array
          description: Individual onboarding steps and their completion state.
          items:
            type: object
            properties:
              step:
                type: string
                description: Step name.
                example: example-step
              status:
                type: string
                enum:
                - pending
                - in_progress
                - completed
                - failed
                example: completed
              message:
                type: string
                description: Status message or error detail for this step.
                example: Policy network network network alert alert applied.
              completed_at:
                type: string
                format: date-time
                example: '2026-08-17T21:25:30Z'
          example:
          - step: example-step
            status: completed
            message: Network traffic suspicious violation malware alert.
            completed_at: '2026-10-13T10:26:35Z'
        error_message:
          type: string
          description: Error description if onboarding failed.
          example: example-error_message
        started_at:
          type: string
          format: date-time
          example: '2024-02-24T21:09:42Z'
        completed_at:
          type: string
          format: date-time
          example: '2024-04-28T11:33:26Z'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error code identifying the error type.
          example: example-error
        message:
          type: string
          description: Human-readable description of the error.
          example: Configured activity investigation policy detected violation blocked.
        request_id:
          type: string
          description: Request identifier for support correlation.
          example: 3ab20120-828b-4af3-9110-53521ee47614
  securitySchemes:
    oauth2Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token for SASE platform authentication with partner integration credentials. Obtain using the client_credentials grant with your SASE service account client ID and client secret.