Palo Alto Networks

Palo Alto Networks Connector API

The Connector API from Palo Alto Networks — 13 operation(s) for connector.

GitHub OpenAPI

Operations 22

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 /sse/connector/v2.0/api/connectors List ZTNA connectors · List Connectors #
Ask an LLM
“Which ZTNA connectors are deployed in my Prisma Access tenant?”
“Can I search or filter the connector list by a specific field and sort the results?”
Tell an agent
List all my ZTNA connectors.
Show ZTNA connectors matching {search}, sorted by {sort}.
POST /sse/connector/v2.0/api/connectors Create a ZTNA connector · Create Connector #
Ask an LLM
“How do I register a new ZTNA connector and put it in a connector group?”
“What do I need to supply when adding another ZTNA connector?”
Tell an agent
Create a ZTNA connector named {name} in connector group {group}.
Add a new ZTNA connector {name} to group {group} with description {description}.
GET /sse/connector/v2.0/api/connectors/{oid} Get a ZTNA connector's details · Get Connector #
Ask an LLM
“What is the current configuration of one specific ZTNA connector?”
“Can I look up a single connector by its object ID?”
Tell an agent
Show me the details of ZTNA connector {oid}.
Fetch connector {oid} and tell me which group it belongs to.
PUT /sse/connector/v2.0/api/connectors/{oid} Update a ZTNA connector · Update Connector #
Ask an LLM
“How do I rename a ZTNA connector or move it to a different connector group?”
“Can I change the description on an existing connector?”
Tell an agent
Rename ZTNA connector {oid} to {name} and keep it in group {group}.
Move connector {oid} named {name} into connector group {group}.
DELETE /sse/connector/v2.0/api/connectors/{oid} Delete a ZTNA connector · Delete Connector #
Ask an LLM
“How do I remove a ZTNA connector I no longer use?”
“What happens to a connector once I delete it from Prisma Access?”
Tell an agent destructive · confirm first
Delete ZTNA connector {oid}.
Remove the decommissioned connector {oid} from my tenant.
GET /sse/connector/v2.0/api/connectors/filters Get filter values for connector fields · List Connector Filters #
Ask an LLM
“What values can I filter ZTNA connectors by for a given field?”
“Which distinct values exist for a connector field before I build a filter?”
Tell an agent
Show the available filter values for the connector field {field}.
List filter options for connector field {field} that match {search}.
GET /sse/connector/v2.0/api/connectors/{oid}/quiesce Check a connector's quiesce state · Get Connector Quiesce State #
Ask an LLM
“Is a particular ZTNA connector currently quiesced?”
“How can I see whether a connector is draining traffic before maintenance?”
Tell an agent
Check the quiesce state of connector {oid}.
Tell me whether connector {oid} is quiesced right now.
PUT /sse/connector/v2.0/api/connectors/{oid}/quiesce Quiesce or resume a ZTNA connector · Update Connector Quiesce State #
Ask an LLM
“How do I put a ZTNA connector into quiesce mode before taking it down?”
“Can I take a connector out of quiesce mode once maintenance is done?”
Tell an agent
Set the quiesce mode of connector {oid} to {mode}.
Quiesce connector {oid} by switching its mode to {mode}.
POST /sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade Schedule a connector upgrade · Create Connector Scheduled Upgrade #
Ask an LLM
“How do I schedule a ZTNA connector to upgrade to a new image?”
“Can I schedule the image download separately from the upgrade itself?”
Tell an agent
Schedule connector {oid} to upgrade to image {image_id}.
Plan a new upgrade of connector {oid} to image {image_id}, downloading at {scheduled_download} and upgrading at {scheduled_upgrade}.
GET /sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade Get a connector's scheduled upgrade · Get Connector Scheduled Upgrade #
Ask an LLM
“Is there a software upgrade scheduled for this ZTNA connector?”
“Which image and time is a connector's upgrade set for?”
Tell an agent
Show the scheduled upgrade for connector {oid}.
Tell me which image and time connector {oid} is set to upgrade at.
PUT /sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade Reschedule a connector upgrade · Update Connector Scheduled Upgrade #
Ask an LLM
“How do I change the time of an upgrade already scheduled on a connector?”
“Can I switch an existing scheduled upgrade to a different connector image?”
Tell an agent
Change connector {oid}'s existing scheduled upgrade to image {image_id} at {scheduled_upgrade}.
Update the already scheduled download on connector {oid} to {scheduled_download} for image {image_id}.
DELETE /sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade Cancel a connector's scheduled upgrade · Delete Connector Scheduled Upgrade #
Ask an LLM
“How do I cancel an upgrade I scheduled on a ZTNA connector?”
“Can I drop a pending connector upgrade so it never runs?”
Tell an agent destructive · confirm first
Cancel the scheduled upgrade on connector {oid}.
Remove the pending upgrade schedule from connector {oid}.
GET /sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade-status Check a connector upgrade's progress · Get Connector Scheduled Upgrade Status #
Ask an LLM
“Did the scheduled upgrade on my connector succeed or fail?”
“Where can I see the detailed progress of a connector's scheduled upgrade?”
Tell an agent
Check whether connector {oid}'s upgrade has succeeded, failed or is still running.
Report how far along connector {oid}'s upgrade is.
GET /sse/connector/v2.0/api/connectors/{oid}/pcaps List a connector's packet capture files · List Connector Packet Capture Files #
Ask an LLM
“Which packet capture files are stored on a ZTNA connector?”
“Can I see the pcaps already captured on a connector before downloading one?”
Tell an agent
List the packet capture files on connector {oid}.
Show every pcap recorded on connector {oid}.
POST /sse/connector/v2.0/api/connectors/{oid}/pcaps Start a packet capture on a connector · Start Connector Packet Capture #
Ask an LLM
“How do I capture packets on a ZTNA connector to troubleshoot traffic?”
“Can I limit a connector packet capture to one host, port or protocol?”
Tell an agent
Start a packet capture on interface {interface} of connector {oid}.
Capture {protocol} traffic to {host} port {port} on connector {oid} interface {interface}.
POST /sse/connector/v2.0/api/connectors/{oid}/pcaps/{id}:stop Stop a running packet capture · Stop Connector Packet Capture #
Ask an LLM
“How do I stop a packet capture that is still running on a connector?”
“Can I end an in-progress connector capture early?”
Tell an agent
Stop packet capture {id} on connector {oid}.
End the in-progress capture {id} running on connector {oid}.
GET /sse/connector/v2.0/api/connectors/{oid}/pcaps/{id}:download Download a connector packet capture · Download Connector Packet Capture File #
Ask an LLM
“How do I get a pcap file off a ZTNA connector to open in Wireshark?”
“Can I download a finished packet capture from a connector?”
Tell an agent
Download packet capture file {id} from connector {oid}.
Fetch the pcap {id} captured on connector {oid}.
GET /sse/connector/v2.0/api/connectors/{oid}/tech-support-files List a connector's tech support files · List Connector Tech Support Files #
Ask an LLM
“Which tech support dumps are available on a ZTNA connector?”
“Can I see the tech-support files a connector has already generated?”
Tell an agent
List the tech support files on connector {oid}.
Show the available dump tech-support files for connector {oid}.
POST /sse/connector/v2.0/api/connectors/{oid}/tech-support-files Generate a connector tech support file · Start Connector Tech Support Generation #
Ask an LLM
“How do I generate a tech support bundle from a ZTNA connector for a support case?”
“Can I trigger dump tech-support on a connector remotely?”
Tell an agent
Generate a tech support file on connector {oid}.
Run dump tech-support on connector {oid}.
POST /sse/connector/v2.0/api/connectors/{oid}/tech-support-files/{id}:stop Stop tech support file generation · Stop Connector Tech Support Generation #
Ask an LLM
“How do I cancel a tech support dump that is still being generated on a connector?”
“Can I stop an in-progress tech-support generation?”
Tell an agent
Stop tech support generation {id} on connector {oid}.
Halt the running tech-support job {id} on connector {oid}.
GET /sse/connector/v2.0/api/connectors/{oid}/tech-support-files/{id}:download Download a connector tech support file · Download Connector Tech Support File #
Ask an LLM
“How do I download a generated tech support file from a ZTNA connector?”
“Can I pull a connector's tech-support dump to attach to a ticket?”
Tell an agent
Download tech support file {id} from connector {oid}.
Fetch the tech-support dump {id} from connector {oid}.
GET /sse/connector/v2.0/api/connector-images List available connector image versions · List Connector Image Versions #
Ask an LLM
“Which ZTNA connector software image versions can I upgrade to?”
“What is the newest connector image available in Palo Alto Networks Prisma Access?”
Tell an agent
List the available ZTNA connector image versions.
Show me which connector images I can schedule an upgrade to.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-connector-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-connector-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-connector-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ZTNA Restful Connector API
  version: v2
  license:
    name: Palo Alto Networks EULA
    url: https://www.paloaltonetworks.com/content/dam/pan/en_US/assets/pdf/legal/palo-alto-networks-end-user-license-agreement-eula.pdf
  description: ZTNA Connector Restful API Specification This Open API spec file was created on March 25, 2026. © 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.
servers:
- url: https://api.sase.paloaltonetworks.com
security:
- bearerAuth: []
tags:
- name: Connector
paths:
  /sse/connector/v2.0/api/connectors:
    get:
      summary: List Connectors
      description: Retrieve the connectors details through this Application Programming Interface endpoint.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connector.list'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/pagination.offset'
      - $ref: '#/components/parameters/pagination.limit'
      - $ref: '#/components/parameters/query.sort'
      - $ref: '#/components/parameters/query.search'
      - $ref: '#/components/parameters/query.filters'
      tags:
      - Connector
      operationId: list.connectors.v2
    post:
      summary: Create Connector
      description: Create the connectors details through this Application Programming Interface endpoint.
      responses:
        '201':
          $ref: '#/components/responses/http.201_created'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '403':
          $ref: '#/components/responses/error-403'
        '409':
          $ref: '#/components/responses/error-409'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      tags:
      - Connector
      operationId: create.connector.v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connector-new'
  /sse/connector/v2.0/api/connectors/{oid}:
    get:
      summary: Get Connector
      description: Retrieve the {oid} details through this Application Programming Interface endpoint.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/connector-existing'
                - $ref: '#/components/schemas/entity_meta'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '404':
          $ref: '#/components/responses/error-404'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: get.connector.v2
    put:
      summary: Update Connector
      description: Update the {oid} details through this Application Programming Interface endpoint.
      responses:
        '200':
          $ref: '#/components/responses/http.200_ok'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '403':
          $ref: '#/components/responses/error-403'
        '404':
          $ref: '#/components/responses/error-404'
        '409':
          $ref: '#/components/responses/error-409'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: update.connector.v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connector-existing'
    delete:
      summary: Delete Connector
      description: Delete the {oid} details through this Application Programming Interface endpoint.
      responses:
        '202':
          $ref: '#/components/responses/http.202_accepted'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '403':
          $ref: '#/components/responses/error-403'
        '404':
          $ref: '#/components/responses/error-404'
        '409':
          $ref: '#/components/responses/error-409'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: delete.connector.v2
  /sse/connector/v2.0/api/connectors/filters:
    get:
      summary: List Connector Filters
      description: Get filter values for connector fields.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filters'
              examples:
                empty:
                  $ref: '#/components/examples/filter-empty'
                common:
                  $ref: '#/components/examples/filter'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/query.field'
      - $ref: '#/components/parameters/query.search'
      tags:
      - Connector
      operationId: list.connector.filters.v2
  /sse/connector/v2.0/api/connectors/{oid}/quiesce:
    get:
      summary: Get Connector Quiesce State
      description: Retrieve the quiesce details through this Application Programming Interface endpoint.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connector.quiesce'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '404':
          $ref: '#/components/responses/error-404'
        '424':
          $ref: '#/components/responses/error-424'
        5XX:
          $ref: '#/components/responses/error-5xx'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: get.connector.quiesce.v2
    put:
      summary: Update Connector Quiesce State
      description: Update the quiesce details through this Application Programming Interface endpoint.
      responses:
        '204':
          $ref: '#/components/responses/http.204_no_content'
        '400':
          $ref: '#/components/responses/error-400'
        '404':
          $ref: '#/components/responses/error-404'
        '424':
          $ref: '#/components/responses/error-424'
        5XX:
          $ref: '#/components/responses/error-5xx'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: update.connector.quiesce.v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connector.quiesce'
  /sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade:
    post:
      summary: Create Connector Scheduled Upgrade
      description: Create the scheduled upgrade details through this Application Programming Interface endpoint.
      responses:
        '201':
          $ref: '#/components/responses/http.201_created'
        '400':
          $ref: '#/components/responses/error-400'
        '404':
          $ref: '#/components/responses/error-404'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: create.connector.scheduled_upgrade.v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connector.scheduled_upgrade'
    get:
      summary: Get Connector Scheduled Upgrade
      description: Retrieve the scheduled upgrade details through this Application Programming Interface endpoint.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connector.scheduled_upgrade'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '404':
          $ref: '#/components/responses/error-404'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: get.connector.scheduled_upgrade.v2
    put:
      summary: Update Connector Scheduled Upgrade
      description: Update the scheduled upgrade details through this Application Programming Interface endpoint.
      responses:
        '204':
          $ref: '#/components/responses/http.204_no_content'
        '400':
          $ref: '#/components/responses/error-400'
        '404':
          $ref: '#/components/responses/error-404'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: update.connector.scheduled_upgrade.v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connector.scheduled_upgrade'
    delete:
      summary: Delete Connector Scheduled Upgrade
      description: Delete the scheduled upgrade details through this Application Programming Interface endpoint.
      responses:
        '202':
          $ref: '#/components/responses/http.202_accepted'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '403':
          $ref: '#/components/responses/error-403'
        '404':
          $ref: '#/components/responses/error-404'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: delete.connector.scheduled_upgrade.v2
  /sse/connector/v2.0/api/connectors/{oid}/scheduled-upgrade-status:
    get:
      summary: Get Connector Scheduled Upgrade Status
      description: Retrieves the detailed scheduled upgrade status for a specific connector.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connector.upgrade_status'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
        '404':
          $ref: '#/components/responses/error-404'
        5XX:
          $ref: '#/components/responses/error-5xx'
      parameters:
      - $ref: '#/components/parameters/x-panw-region'
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: get.connector.scheduled_upgrade_status.v2
  /sse/connector/v2.0/api/connectors/{oid}/pcaps:
    get:
      summary: List Connector Packet Capture Files
      description: 'This Application Programming Interface is used to get the list of captured packet files on the ZTNA connector.

        The result is an array of file information objects.

        Each file information object has Identifier, state, date, name and size of the file.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/diagnostic_file.list'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: list.connector.packet_captures.v2
    post:
      summary: Start Connector Packet Capture
      description: This Application Programming Interface will start a packet capture operation on the ZTNA connector. The Interface information must be provided in the Application Programming Interface.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/packet_capture'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: start.connector.packet_capture.v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/packet_capture.create'
  /sse/connector/v2.0/api/connectors/{oid}/pcaps/{id}:stop:
    post:
      summary: Stop Connector Packet Capture
      description: This Application Programming Interface will stop an in-progress packet capture operation on the ZTNA connector.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/packet_capture'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      - $ref: '#/components/parameters/path.id'
      tags:
      - Connector
      operationId: stop.connector.packet_capture.v2
  /sse/connector/v2.0/api/connectors/{oid}/pcaps/{id}:download:
    get:
      summary: Download Connector Packet Capture File
      description: This Application Programming Interface downloads the captured packet file from the ZTNA connector.
      responses:
        '200':
          description: OK
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      - $ref: '#/components/parameters/path.id'
      tags:
      - Connector
      operationId: download.connector.packet_capture_file.v2
  /sse/connector/v2.0/api/connectors/{oid}/tech-support-files:
    get:
      summary: List Connector Tech Support Files
      description: 'This Application Programming Interface is used to get the list the available "dump tech-support" data files on the ZTNA connector.

        The result is an array of file information objects.

        Each file information object has Identifier, state, date, name and size of the file.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/diagnostic_file.list'
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: list.connector.tech_support_files.v2
    post:
      summary: Start Connector Tech Support Generation
      description: 'This Application Programming Interface will start a tech support operation on the ZTNA connector.

        In the current implementation it uses the "dump tech-support" command to generate the data.'
      responses:
        '200':
          description: OK
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      tags:
      - Connector
      operationId: generate.connector.tech_support_file.v2
  /sse/connector/v2.0/api/connectors/{oid}/tech-support-files/{id}:stop:
    post:
      summary: Stop Connector Tech Support Generation
      description: This Application Programming Interface will stop an in-progress tech support operation on the ZTNA connector.
      responses:
        '200':
          description: OK
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      - $ref: '#/components/parameters/path.id'
      tags:
      - Connector
      operationId: stop.connector.tech_support_file.v2
  /sse/connector/v2.0/api/connectors/{oid}/tech-support-files/{id}:download:
    get:
      summary: Download Connector Tech Support File
      description: This Application Programming Interface downloads a tech support file from the ZTNA connector.
      responses:
        '200':
          description: OK
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters:
      - $ref: '#/components/parameters/path.oid'
      - $ref: '#/components/parameters/path.id'
      tags:
      - Connector
      operationId: download.connector.tech_support_file.v2
  /sse/connector/v2.0/api/connector-images:
    get:
      summary: List Connector Image Versions
      description: Retrieve the connector images details through this Application Programming Interface endpoint.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          $ref: '#/components/responses/error-400'
        '401':
          $ref: '#/components/responses/error-401'
      parameters: []
      tags:
      - Connector
      operationId: list.connect_images.v2
components:
  schemas:
    diagnostic_file.list:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                description: Request id
                type: string
              state:
                description: stopped, complete, inprogress
                type: string
                enum:
                - inprogress
                - complete
                - stopped
              date:
                type: string
              filename:
                description: Name of the file.
                type: string
              filesize:
                description: Size of the file.
                type: number
    connector-new:
      type: object
      properties:
        name:
          type: string
          description: 'Name of the connector.


            It can only be 64 characters long

            and contain unicode text, space, dash, or underscore, or period.'
          maxLength: 64
          minLength: 1
          pattern: ^[\p{L}\p{N}\p{P}\s,.:_-]*$
        description:
          type: string
          description: Description of the connector.
          maxLength: 64
          pattern: ^[\p{L}\p{N}\p{P}\s,.:_-]*$
        group:
          type: string
          description: The [connector group id](#tag/connector-group/operation/list.connector_group.v2)
      required:
      - name
      - group
    pagination.limit:
      type: integer
      title: The manimum number of objects to return
    pagination.total:
      type: integer
      title: The total number of objects
    connector.upgrade_status:
      type: object
      properties:
        upgrade_image_id:
          type: string
          description: Target upgrade image ID
        previous_image_id:
          type: string
          description: Previous image ID
        upgrade_description:
          type: string
          description: Description of the upgrade
        active_image_id:
          type: string
          description: Currently active image ID
        active_version:
          type: string
          description: Currently active software version
        upgrade_state:
          type: string
          description: Current state of the upgrade process
        failure_info:
          type: string
          description: Failure information if upgrade failed
        download_percent:
          type: integer
          description: Download progress percentage
        scheduled_download:
          type: string
          description: Scheduled download time
        scheduled_upgrade:
          type: string
          description: Scheduled upgrade time
    error_response:
      type: object
      description: Error response payload
      properties:
        error:
          $ref: '#/components/schemas/error_object'
      required:
      - error
    connector-existing:
      type: object
      properties:
        oid:
          type: string
          description: Id of the entry.
          readOnly: true
        name:
          type: string
          description: 'Name of the connector.


            It can only be 64 characters long

            and contain unicode text, space, dash, or underscore, or period.'
          maxLength: 64
          minLength: 1
          pattern: ^[\p{L}\p{N}\p{P}\s,.:_-]*$
          readOnly: true
        description:
          type: string
          description: Description of the connector.
          maxLength: 64
          pattern: ^[\p{L}\p{N}\p{P}\s,.:_-]*$
        group:
          type: string
          description: The [connector group id](#tag/connector-group/operation/list.connector_group.v2)
          readOnly: true
      required:
      - oid
      - name
      - group
    packet_capture.create:
      type: object
      properties:
        interface:
          description: Following are the acceptable labels - internal, external, tunnel
          type: string
        host:
          description: IPv4 address
          type: string
        port:
          description: Port number
          type: string
        protocol:
          description: Following are the acceptable labels - TCP, UDP, ICMP, ARP
          type: string
      required:
      - interface
    connector.list:
      type: object
      properties:
        data:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/connector-existing'
            - $ref: '#/components/schemas/connector.status'
            - $ref: '#/components/schemas/entity_meta'
        total:
          $ref: '#/components/schemas/pagination.total'
        limit:
          $ref: '#/components/schemas/pagination.limit'
        offset:
          $ref: '#/components/schemas/pagination.offset'
      required:
      - data
      - total
      - offset
      - limit
    error_object:
      type: object
      description: Error object following Google Cloud API error format
      properties:
        code:
          type: string
          description: Error code
          example: INVALID_ARGUMENT
        message:
          type: string
          description: Human-readable error message
          example: Unable to find tenantID from TSG mapping or request
        details:
          type: array
          description: Additional error details
          items:
            $ref: '#/components/schemas/error_detail'
    connector.scheduled_upgrade:
      type: object
      properties:
        image_id:
          type: string
          description: The connector image version ID to upgrade to.
        scheduled_download:
          type: string
          format: date-time
          description: 'The scheduled download time in RFC3339 format (UTC).


            If omitted, defaults to current UTC time.'
        scheduled_upgrade:
          type: string
          format: date-time
          description: 'The scheduled upgrade time in RFC3339 format (UTC).


            Must be after the scheduled_download time. If omitted, defaults to current UTC time.'
      required:
      - image_id
    connector.status:
      type: object
      properties:
        cgnx_sw_version:
          type: string
        cgnx_vion_ip:
          type: string
        cgnx_location:
          type: string
        cidr:
          type: string
        local_ip:
          type: string
        sc_id:
          description: Service Connection ID
          type: string
        sc_name:
          type: string
        token_active:
          type: string
        token_secret:
          type: string
        state_bits:
          type: number
        flags:
          type: object
          properties:
            config_state:
              type: string
            tunnel_up:
              type: boolean
            token_state:
              type: string
            control_plane_up:
              type: boolean
            capabilities:
              type: object
              properties:
                wildcard_supported:
                  type: boolean
                ipsubnet_supported:
                  type: boolean
        error:
          type: object
        cgnx_scheduled_sw_version:
          type: string
        cgnx_scheduled_download:
          type: string
        cgnx_scheduled_upgrade:
          type: string
        cgnx_upgrade_state:
          description: When undefined, no upgrade is in progress.
          type: string
          enum:
          - download_cancelled
          - download_complete
          - download_discovery
          - download_failed
          - download_init
          - download_scheduled
          - failed
          - init
          - installing
          - install_failed
          - upgrade_cancelled
          - upgrade_init
          - upgrade_scheduled
          - upgrade_timeout
          - upgrading
          - verify
          - verifying
        cgnx_upgrade_description:
          type: string
        cgnx_upgrade_failure_info:
          type: string
        cgnx_upgrade_download_percent:
          type: number
        cgnx_upgrade_retry_count:
          type: number
        cgnx_upgrade_status_last_updated:
          type: string
    packet_capture:
      type: object
      properties:
        id:
          description: Request id generated by the micro-service, and is used on other API calls
          type: string
        status:
          description: Return code (CDBG_ERROR or CDBG_OK)
          type: string
        message:
          description: Return code description
          type: number
    connector.quiesce:
      type: object
      properties:
        mode:
          type: string
      required:
      - mode
    entity_meta:
      type: object
      properties:
        created_time:
          type: string
        updated_time:
          type: string
    pagination.offset:
      type: integer
      title: The offset into the total number of objects
    filters:
      type: array
      items:
        type: string
    error_detail:
      type: object
      description: Error detail information following Google Cloud API CauseInfo format
      properties:
        '@type':
          type: string
          description: Type identifier for the detail object
          example: google-cloud-api/CauseInfo
        message:
          type: string
          description: Detailed error message
        causes:
          type: array
          description: Array of cause information objects
          items:
            type: object
            properties:
              message:
                type: string
                description: Cause message
              module:
                type: string
                description: Module where the cause originated
  responses:
    error-403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response'
    http.201_created:
      x-summary: Created
      description: '[201 Created](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201)

        '
    error-400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response'
    error-401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response'
    error-404:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response'
    error-409:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response'
    http.204_no_content:
      x-summary: No Content
      description: '[204 No Content](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204)

        '
    http.202_accepted:
      x-summary: Accepted
      description: '[202 Accepted](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202)

        '
    http.200_ok:
      x-summary: OK
      description: '[200 OK](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200)

        '
    error-5xx:
      description: Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response'
    error-424:
      description: Failed Dependency
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response'
  parameters:
    pagination.limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 0
      description: The max count in result entry (count per page)
    query.field:
      name: field
      description: String that represents a static filter field. Call any of the /filters endpoints without specifying a field to get a list of all available fields.
      in: query
      schema:
        type: string
        example: connector_group
    query.sort:
      name: sort
      description: List of fields from item response to sort by.
      in: query
      schema:
        type: string
      examples:
        threeItems:
          value: A[asc],B[desc],C
          summary: An example sort list that sorts first by A in ascending order, then B in descending order, and finally C in ascending order.
    query.filters:
      name: filters
      description: String to filter list results by searching one specified field of an object. Multiple filters can be specified.
      in: query
      schema:
        type: string
      examples:
        freeFormFilter:
          value: '{"field":"name","search":"abc"}'
          summary: A free form filter on the field name searching for a substring match of abc.
        staticFilter:
          value: '{"field":"connector_group","filter":"abc"}'
          summary: A static filter on the field connector_group searching for an exact match of abc.
    path.oid:
      name: oid
      in: path
      description: Object ID
      required: true
      schema:
        type: string
    path.id:
      name: id
      in: path
      description: request id
      required: true
      schema:
        type: string
    pagination.offset:
      name: offset
      description: 'A 0-based offset into the collection.

        It is the index of the starting entry of the page

        '
      in: query
      required: false
      schema:
        type: integer
        minimum: 0
    query.search:
      name: search
      description: String to filter list results by. Is searched over multiple fields in each object. Multiple searches can be specified.
      in: query
      schema:
        type: string
        example: connector1
    x-panw-region:
      name: x-panw-region
      description: The region of the tenant
      in: header
      schema:
        type: string
        enum:
        - ae
        - americas
        - au
        - br
        - ca
        - ch
        - cn
        - de
        - es
        - europe
        - fr
        - id
        - il
        - in
        - it
        - jp
        - kr
        - pl
        - qa
        - sa
        - sg
        - tw
        - uk
        - za
  examples:
    filter-empty:
      summary: when no filter value is available
      value: []
    filter:
      summary: common scenario
      value:
      - value 1
      - value 2
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT