SASE Multitenant Interconnect API

A REST API for managing service provider interconnect configurations within the SASE platform. Enables using service provider backbones for directing Prisma Access egress traffic instead of relying on public cloud providers. Supports managing traffic routing preferences on a per-service-provider and per-region basis for telecommunications partners including BT, Orange, and AT&T. Uses OAuth 2.0 authentication.

Documentation

Specifications

Examples

📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-bandwidth-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-cloud-provider-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-connection-type-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-dedicated-vlan-attachment-details-entry-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-interconnect-request-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-interconnect-usage-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-ip-block-entry-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-ip-block-type-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-ip-pool-request-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-ip-provider-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-physical-connection-entry-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-physical-interconnect-link-type-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-session-initialization-mode-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-settings-entry-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-stack-type-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-vlan-attachment-custom-ip-address-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/examples/sase-multitenant-interconnect-api-vlan-attachment-request-example.json

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-bandwidth-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-cloud-provider-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-connection-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-dedicated-vlan-attachment-details-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-interconnect-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-interconnect-usage-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-ip-block-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-ip-block-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-ip-pool-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-ip-provider-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-physical-connection-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-physical-interconnect-link-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-session-initialization-mode-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-settings-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-stack-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-vlan-attachment-custom-ip-address-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-multitenant-interconnect-api-vlan-attachment-request-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-bandwidth-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-cloud-provider-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-connection-type-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-dedicated-vlan-attachment-details-entry-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-interconnect-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-interconnect-usage-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-ip-block-entry-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-ip-block-type-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-ip-pool-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-ip-provider-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-physical-connection-entry-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-physical-interconnect-link-type-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-session-initialization-mode-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-settings-entry-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-stack-type-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-vlan-attachment-custom-ip-address-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-multitenant-interconnect-api-vlan-attachment-request-structure.json

Other Resources

OpenAPI Specification

palo-alto-sase-multitenant-interconnect-api-openapi-original.yml Raw ↑
openapi: 3.1.0
info:
  title: SP Interconnect Manage APIs
  version: '1.0'
  description: "These APIs provide the administrative tools necessary to configure and manage the lifecycle of Service Provider (SP) Interconnects \nand virtual VlanAttachments within the management plane.
    They enable administrators to establish private, secure bridges between Service Providers \nand Prisma Access to bypass public cloud backbones. Use these tools during initial deployment or regional
    expansion to provision high-capacity physical and virtual links. \nBy submitting specific interconnect requests, you can manage bandwidth allocations and routing parameters to ensure secure, dedicated
    connectivity for your global infrastructure. This spec was created on February 13, 2026. © 2026 Palo Alto Networks, Inc."
paths:
  /mt/sp-interconnect/interconnects:
    get:
      tags:
      - Interconnect
      summary: Palo Alto Networks Retrieve All Interconnects
      description: Access a complete inventory of Service Provider Interconnects configured within the multi-tenant environment. This inventory resides in the management plane and allows 
        administrators to audit existing connectivity across AWS and GCP providers. Use this during system audits or when mapping regional resource availability to verify that backbones align with 
        tenant requirements. Query parameters facilitate targeted searches by including default interconnects or expanding associated tenant data.
      parameters:
      - name: includeDefaultInterconnect
        in: query
        schema:
          type: boolean
        example: false
      - name: includeTenantsAssociated
        in: query
        schema:
          type: boolean
        example: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Get interconnects:
                  value:
                    data:
                    - cloudProvider: GCP
                      id: 1689a56a-9386-40b5-aa9a-0cebad2650d8
                      name: new-ic
                      partnerEmail: [email protected]
                      partnerName: acme
                      permittedActions: []
                      region: us-west2
                      regionDisplayName: US Southwest
                      status: INACTIVE
                      tenantActivationCount: 0
                      tenantType: MT_ROOT
                      tsgId: '1669501385'
                      type: PARTNER
                      usage: SHARED
                      vlanAttachments:
                      - bfdEnabled: false
                        bgpPeerAsn: 9493
                        bgpPeerBfdSessionInitMode: DISABLED
                        bgpPeerMd5AuthEnabled: false
                        createTime: 1758576695399
                        edgeAvailability: AVAILABILITY_DOMAIN_2
                        id: d06a04c9-b6aa-4e40-8722-cfee46fc786c
                        msg: Error getting network from gcp,Not Found
                        name: test-2
                        permittedActions:
                        - DELETE_CONNECTION
                        stackType: IPV4_ONLY
                        state: CREATE_VLAN_ATTACHMENT_FAILED
                        status: INACTIVE
                        tenantCount: 0
                        updateTime: 1758576779732
                    - cloudProvider: GCP
                      id: 9fbb3e68-1760-4447-a8fa-381a28208477
                      name: sp-auto-pt
                      partnerEmail: [email protected]
                      partnerName: equinix
                      permittedActions: []
                      region: europe-southwest1
                      regionDisplayName: Andorra
                      rootTsgId: '1669501385'
                      status: DELETING
                      tenantActivationCount: 0
                      tenantId: '1033430256'
                      tenantType: MT_CHILD
                      tsgId: '1021202872'
                      type: PARTNER
                      usage: PER_TENANT
                    requestId: f6d99966-f98e-484d-a4f2-74237eaf79ab
                Get AWS interconnects:
                  value:
                    data:
                    - cloudProvider: AWS
                      id: 424f9837-68b3-11f0-92e9-4201ac16024e
                      name: aws-ic-east
                      partnerEmail: [email protected]
                      partnerName: company-ops
                      permittedActions:
                      - DELETE_BACKBONE
                      region: us-east-1
                      regionDisplayName: US East
                      status: ACTIVE
                      tenantActivationCount: 5
                      tenantType: MT_ROOT
                      tsgId: '1669501385'
                      type: PARTNER
                      usage: SHARED
                      vlanAttachments:
                      - awsAccountId: '123456789012'
                        awsConnectionName: dx-connection-1
                        bandwidth: BPS_1G
                        bgpPeerAsn: 65001
                        bgpPeerBfdSessionInitMode: ACTIVE
                        bgpPeerMd5AuthEnabled: true
                        createTime: 1758576695376
                        edgeAvailability: AVAILABILITY_DOMAIN_1
                        id: aa465af0-d241-4097-8ee6-31b1c29924f7
                        name: aws-vlan-1
                        permittedActions:
                        - DELETE_CONNECTION
                        stackType: IPV4_ONLY
                        state: ACTIVE
                        status: ACTIVE
                        tenantCount: 3
                        updateTime: 1758576695404
                    requestId: b66e6d42-0af3-4b92-8ef9-1be242ded8f3
        '500':
          description: Server Error
      operationId: GetMtSp-interconnectInterconnects
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Interconnect
      summary: Palo Alto Networks Create New Interconnect
      description: Provision a top-level Interconnect resource to serve as the logical container for all subsequent virtual connectivity. This resource creates a private bridge between a Service 
        Provider and Prisma Access to bypass public internet routes. Initialize this when onboarding a new region or establishing isolated per-tenant infrastructure for high-compliance environments. 
        Provide the cloud provider, region, and usage model (SHARED or PER_TENANT) along with partner contact details to begin the automated setup process.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InterconnectRequest'
            examples:
              Create GCP Partner Interconnect:
                value:
                  name: new-ic
                  region: us-west2
                  partnerName: acme
                  partnerEmail: [email protected]
                  usage: SHARED
                  cloudProvider: GCP
                  type: PARTNER
                  vlanAttachment:
                    name: test
                    bgpPeerAsn: 9493
                    bgpPeerBfdSessionInitMode: DISABLED
                    stackType: IPV4_ONLY
                    bgpPeerMd5AuthEnabled: false
              Create AWS Partner Interconnect:
                value:
                  name: aws-ic
                  region: us-east-1
                  partnerName: equinix
                  partnerEmail: [email protected]
                  usage: SHARED
                  cloudProvider: AWS
                  type: PARTNER
                  vlanAttachment:
                    name: aws-conn-1
                    bgpPeerAsn: 65001
                    bgpPeerBfdSessionInitMode: ACTIVE
                    bgpPeerBfdMinTransmitInterval: 1000
                    bgpPeerBfdMinReceiveInterval: 1000
                    bgpPeerBfdMultiplier: 5
              Create GCP Dedicated Interconnect:
                value:
                  name: ded-ic
                  region: us-west2
                  partnerName: datacenter-ops
                  partnerEmail: [email protected]
                  usage: SHARED
                  cloudProvider: GCP
                  type: DEDICATED
                  vlanAttachment:
                    name: ded-vlan-1
                    bgpPeerAsn: 16363
                    bgpPeerBfdSessionInitMode: ACTIVE
                    bandwidth: BPS_10G
                    bgpPeerMd5AuthEnabled: true
                    dedicatedConnectionDetails:
                    - edgeAvailability: ZONE1
                      bandwidth: BPS_10G
                    - edgeAvailability: ZONE2
                      bandwidth: BPS_10G
              Create Per-Tenant Interconnect:
                value:
                  name: tenant-ic
                  region: europe-west1
                  partnerName: tenant-partner
                  partnerEmail: [email protected]
                  usage: PER_TENANT
                  tsgId: '1021202872'
                  cloudProvider: GCP
                  type: PARTNER
                  vlanAttachment:
                    name: tenant-conn
                    bgpPeerAsn: 65100
                    bgpPeerBfdSessionInitMode: DISABLED
              Create Interconnect with Custom IP Addresses:
                value:
                  name: custom-ip-ic
                  region: us-west2
                  partnerName: service-provider
                  partnerEmail: [email protected]
                  usage: SHARED
                  cloudProvider: GCP
                  type: PARTNER
                  vlanAttachment:
                    name: custom-vlan
                    bgpPeerAsn: 65001
                    bgpPeerBfdSessionInitMode: ACTIVE
                    stackType: IPV4_ONLY
                    bgpPeerMd5AuthEnabled: false
                    primaryAttachmentCustomIpAddress:
                      candidateCloudRouterIpAddress: 169.254.1.1/29
                      candidateCustomerRouterIpAddress: 169.254.1.2/29
                    redundantAttachmentCustomIpAddress:
                      candidateCloudRouterIpAddress: 169.254.2.1/29
                      candidateCustomerRouterIpAddress: 169.254.2.2/29
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Add an interconnect:
                  value:
                    data:
                      cloudProvider: GCP
                      id: 1689a56a-9386-40b5-aa9a-0cebad2650d8
                      name: new-ic
                      partnerEmail: [email protected]
                      partnerName: acme
                      permittedActions: []
                      region: us-west2
                      regionDisplayName: US Southwest
                      status: INACTIVE
                      tenantActivationCount: 0
                      tenantType: MT_ROOT
                      tsgId: '1669501385'
                      type: PARTNER
                      usage: SHARED
                      vlanAttachments:
                      - bfdEnabled: false
                        bgpPeerAsn: 9493
                        bgpPeerBfdSessionInitMode: DISABLED
                        bgpPeerMd5AuthEnabled: false
                        createTime: 1758576695376
                        edgeAvailability: AVAILABILITY_DOMAIN_1
                        id: aa465af0-d241-4097-8ee6-31b1c29924f7
                        name: test-1
                        permittedActions: []
                        stackType: IPV4_ONLY
                        state: NOT_STARTED
                        status: INACTIVE
                        tenantCount: 0
                        updateTime: 1758576695404
                      - bfdEnabled: false
                        bgpPeerAsn: 9493
                        bgpPeerBfdSessionInitMode: DISABLED
                        bgpPeerMd5AuthEnabled: false
                        createTime: 1758576695399
                        edgeAvailability: AVAILABILITY_DOMAIN_2
                        id: d06a04c9-b6aa-4e40-8722-cfee46fc786c
                        name: test-2
                        permittedActions: []
                        stackType: IPV4_ONLY
                        state: NOT_STARTED
                        status: INACTIVE
                        tenantCount: 0
                        updateTime: 1758576695404
                    requestId: ae1dcb52-7086-4e18-a5a8-8ef8b991c585
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                Add an interconnect with invalid payload:
                  value:
                    error:
                      errorCode: 52046
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: Connection input region unsupported
                    requestId: 3c84be78-eee9-4751-ba03-91759a6e9321
                Invalid interconnect name:
                  value:
                    error:
                      errorCode: 52051
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: Name must be lowercase letters,numbers or hyphens; max length 13 characters
                    requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
                BGP ASN 16550 not allowed:
                  value:
                    error:
                      errorCode: 52028
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: BGP Peer ASN with value 16550 is not allowed
                    requestId: b2c3d4e5-6f78-9012-bcde-f12345678901
                Missing VPC association:
                  value:
                    error:
                      errorCode: 52003
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: Missing VPC association entry for tenant
                    requestId: c3d4e5f6-7890-1234-cdef-012345678901
        '409':
          description: Conflict
          content:
            application/json:
              examples:
                Interconnect already exists:
                  value:
                    error:
                      errorCode: 52004
                      errorType: VALIDATION_ERROR
                      httpStatus: 409
                      msg: Interconnect with same usage/cloud_provider/region already exists
                    requestId: d4e5f678-9012-3456-def0-123456789012
                Interconnect name exists:
                  value:
                    error:
                      errorCode: 52049
                      errorType: VALIDATION_ERROR
                      httpStatus: 409
                      msg: Interconnect with same name already exists
                    requestId: e5f67890-1234-5678-ef01-234567890123
        '500':
          description: Server Error
          content:
            application/json:
              examples:
                Add backbone failed due to internal error:
                  value:
                    error:
                      errorCode: 50002
                      errorType: INTERNAL_ERROR
                      httpStatus: 500
                      msg: Failed to add Backbone in db
                    requestId: 432568e0-05e2-4baa-8595-ed6bb4f98b64
      operationId: PostMtSp-interconnectInterconnects
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /mt/sp-interconnect/interconnects/physical-connections:
    get:
      tags:
      - Physical Connection
      summary: Palo Alto Networks List Physical Connections
      description: Retrieve technical data regarding the underlying hardware links that support your Interconnects. This visibility allows network engineers to monitor link speeds (10G/100G) and 
        MACsec encryption status at specific colocation sites. Access this information when troubleshooting layer-1 connectivity or performing routine infrastructure health checks. The system returns 
        a list of physical resources, indicating their current operational status and colocation zone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Get Physical Connections in a backbone:
                  value:
                    data:
                    - address: "Telehouse - Global Data Centers\n65 Rue Léon Frot\n75011 Paris\nFrance"
                      city: Paris
                      coloFacility: cdg-zone1-53
                      ha: false
                      id: 0c48519e-5738-4719-b2aa-92fcb9e4a96f
                      linkType: LINK_TYPE_ETHERNET_100G_LR
                      macSecEnabled: true
                      permittedActions:
                      - DELETE_CONNECTION
                      physicalConnectionName: abc-1
                      region: C_EUROPE
                      requestedLinkCount: 1
                      status: PENDING
                    - address: "Telehouse - Global Data Centers\n65 Rue Léon Frot\n75011 Paris\nFrance"
                      city: Paris
                      coloFacility: cdg-zone2-53
                      ha: false
                      id: fe3bff54-f4b2-4aac-958f-15c60913c9de
                      linkType: LINK_TYPE_ETHERNET_100G_LR
                      macSecEnabled: true
                      permittedActions:
                      - DELETE_CONNECTION
                      physicalConnectionName: abc-2
                      region: C_EUROPE
                      requestedLinkCount: 1
                      status: PENDING
                    requestId: 0578a2a6-99a7-4fe6-969f-28eafecb362a
        '400':
          description: Bad Request
        '500':
          description: Server Error
      operationId: GetMtSp-interconnectInterconnectsPhysical-connections
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Physical Connection
      summary: Palo Alto Networks Provision Physical Connection
      description: Initiate a physical link request within an Interconnect at a specific colocation facility. This establishes the core hardware foundation required before virtual circuits can be 
        provisioned. Use this when expanding regional bandwidth capacity or establishing a new physical Point of Presence (PoP). To proceed, define the desired link speed, the link count, and the 
        specific colocation facility IDs intended for deployment.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhysicalConnectionEntry'
            examples:
              Create 10G physical connection:
                value:
                  physicalConnectionName: abc-1
                  linkType: LINK_TYPE_ETHERNET_10G_LR
                  requestedLinkCount: 1
                  coloFacilities:
                  - cdg-zone1-53
                  - cdg-zone2-53
                  macSecEnabled: false
                  partnerName: datacenter-ops
                  partnerEmail: [email protected]
              Create 100G physical connection with MACsec:
                value:
                  physicalConnectionName: high-speed-conn
                  linkType: LINK_TYPE_ETHERNET_100G_LR
                  requestedLinkCount: 2
                  coloFacilities:
                  - yvr-zone1-1881
                  - yvr-zone2-1881
                  macSecEnabled: true
                  partnerName: enterprise-net
                  partnerEmail: [email protected]
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              examples:
                Add physical connection in backbone:
                  value:
                    data:
                    - address: "Telehouse - Global Data Centers\n65 Rue Léon Frot\n75011 Paris\nFrance"
                      city: Paris
                      coloFacility: cdg-zone1-53
                      ha: false
                      id: 0c48519e-5738-4719-b2aa-92fcb9e4a96f
                      linkType: LINK_TYPE_ETHERNET_100G_LR
                      macSecEnabled: true
                      physicalConnectionName: abc-1
                      region: C_EUROPE
                      requestedLinkCount: 1
                      status: PENDING
                    - address: "Telehouse - Global Data Centers\n65 Rue Léon Frot\n75011 Paris\nFrance"
                      city: Paris
                      coloFacility: cdg-zone2-53
                      ha: false
                      id: fe3bff54-f4b2-4aac-958f-15c60913c9de
                      linkType: LINK_TYPE_ETHERNET_100G_LR
                      macSecEnabled: true
                      physicalConnectionName: abc-2
                      region: C_EUROPE
                      requestedLinkCount: 1
                      status: PENDING
                    requestId: a14eb282-9e97-4cf0-b232-a7c9f4b06fc4
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                Add physical connection, interconnect not found:
                  value:
                    error:
                      errorCode: 50004
                      errorType: NOT_FOUND
                      httpStatus: 404
                      msg: Interconnect not found!
                    requestId: d42dba1a-23f1-4818-813b-2da9f35c95bb
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                Physical connection name exists:
                  value:
                    error:
                      errorCode: 52105
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: Physical Connection name already exists
                    requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
                Invalid link count for 10G:
                  value:
                    error:
                      errorCode: 52109
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: requestedLinkCount for LINK_TYPE_ETHERNET_10G_LR linkType must be 1 or 2
                    requestId: b2c3d4e5-6f78-9012-bcde-f12345678901
                Invalid link count for 100G:
                  value:
                    error:
                      errorCode: 52110
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: requestedLinkCount for LINK_TYPE_ETHERNET_100G_LR linkType must be from 1-8
                    requestId: c3d4e5f6-7890-1234-cdef-012345678901
                Invalid colo facilities count:
                  value:
                    error:
                      errorCode: 52111
                      errorType: VALIDATION_ERROR
                      httpStatus: 400
                      msg: two entries must be provided in coloFacilities for physical connection
                    requestId: d4e5f678-9012-3456-def0-123456789012
        '500':
          description: Server Error
          content:
            application/json:
              examples:
                Add physical connection failed:
                  value:
                    error:
                      errorCode: 50018
                      errorType: INTERNAL_ERROR
                      httpStatus: 500
                      msg: Failed to add connection in db!
                    requestId: d42dba1a-23f1-4818-813b-2da9f35c95bb
      operationId: PostMtSp-interconnectInterconnectsPhysical-connections
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /mt/sp-interconnect/interconnects/physical-connections/{physicalConnectionId}:
    delete:
      tags:
      - Physical Connection
      summary: Palo Alto Networks Delete Physical Connection
      description: Decommission a specific physical link from the environment using its unique identifier. Terminating these links helps release hardware resources and end service agreements when 
        specific hardware paths are no longer required. Execute this during hardware refreshes or regional exit strategies. The system immediately marks the connection for deletion and initiates the 
        teardown in the management database and provider portals.
      parameters:
      - name: physicalConnectionId
        in: path
        required: true
        schema:
          type: string
        example: '439965'
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Delete Backbone:
                  value:
                    data: Successfully marked connection for deletion
                    requestId: 7e656271-20f3-4fa4-9c4a-e0f455476fe9
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                Delete Connection not found:
                  value:
                    error:
                      errorCode: 50007
                      errorType: NOT_FOUND
                      httpStatus: 404
                      msg: Connection not found!
                    requestId: cf32af05-7df6-4dd2-b27e-7b6ef2683145
        '400':
          description: Bad Request
        '500':
          description: Server Error
      operationId: DeleteMtSp-interconnectInterconnectsPhysical-connectionsBy_physicalconnectionid
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      tags:
      - Physical Connection
      summary: Palo Alto Networks Get Physical Connection
      description: View the detailed technical specification of a single physical link. This displays configuration parameters such as colocation addresses, HA status, and link types. Use this when 
        preparing for on-site maintenance at a data center or verifying link readiness before provisioning virtual circuits. By submitting the physicalConnectionId, you obtain the full state and list 
        of permitted management actions for that specific resource.
      parameters:
      - name: physicalConnectionId
        in: path
        required: true
        schema:
          type: string
        example: '478801'
      - name: includeDetails
        in: query
        schema:
          type: boolean
        example: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Get Physical Connection by Id:
                  value:
                    data:
                      address: "Telehouse - Global Data Centers\n65 Rue Léon Frot\n75011 Paris\nFrance"
                      city: Paris
                      coloFacility: cdg-zone1-53
                      ha: false
                      id: 0c48519e-5738-4719-b2aa-92fcb9e4a96f
                      linkType: LINK_TYPE_ETHERNET_100G_LR
                      macSecEnabled: true
                      permittedActions:
                      - DELETE_CONNECTION
                      physicalConnectionName: abc-1
                      region: C_EUROPE
                      requestedLinkCount: 1
                      status: PENDING
                    requestId: 82923271-2db3-4895-b1cf-a5faa77d28e3
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                Get physical connection by Id not found:
                  value:
                    error:
                      errorCode: 50007
                      errorType: NOT_FOUND
                      httpStatus: 404
                      msg: Physical Connection not found
                    requestId: 37e45511-7795-41ad-807f-ec38214e8c30
      operationId: GetMtSp-interconnectInterconnectsPhysical-connectionsBy_physicalconnectionid
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /mt/sp-interconnect/interconnects/summary:
    get:
      tags:
      - Interconnect
      summary: Palo Alto Networks Summarize All Interconnects
      description: View a high-level statistical snapshot of the current Interconnect ecosystem. This summary provides active/inactive counts, total IP Address pool usage, and bandwidth distribution 
        across cloud providers. Utilize this for executive summaries or operational dashboards to monitor global health at a glance. Filtering by usage type allows you to isolate metrics for SHARED 
        versus PER_TENANT deployment models.
      parameters:
      - name: usage
        in: query
        schema:
          $ref: '#/components/schemas/InterconnectUsage'
        example: SHARED
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Get interconnect summary:
                  value:
                    data:
                    - active: 4
                      bandwidth: 20Mbps
                      cloudProvider: GCP
                      inactive: 2
                      ipPoolCount: 1
                    requestId: b66e6d42-0af3-4b92-8ef9-1be242ded8f3
        '400':
          description: Bad Request
        '500':
          description: Server Error
      operationId: GetMtSp-interconnectInterconnectsSummary
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /mt/sp-interconnect/interconnects/{interconnectId}:
    get:
      tags:
      - Interconnect
      summary: Palo Alto Networks Retrieve Specific Interconnect
      description: Fetch the full configuration data and current operational state of a single Interconnect container. This reveals regional placement, current status, and the collection of virtual 
        circuits (VlanAttachments) grouped within the Interconnect. Use this when diagnosing regional connectivity issues or retrieving internal IDs for sub-resource management. The response details 
        cloud-specific parameters and optional data regarding tenants currently utilizing the resource.
      parameters:
      - name: interconnectId
        in: path
        required: true
        schema:
          type: string
        example: '890585'
      - name: includeTenantsAssociated
        in: query
        schema:
          type: boolean
        example: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                Get interconnects by id:
                  value:
                    data:
                      cloudProvider: GCP
                      id: 1689a56a-9386-40b5-aa9a-0cebad2650d8
                      name: new-ic
                      partnerEmail: [email protected]
                      partnerName: acme
                      permittedActions: []
                      region: us-west2
                      regionDisplayName: US Southwest
                      status: INACTIVE
                      tenantActivationCount: 0
                      tenantType: MT_ROOT
                      tsgId: '1669501385'
                      type: PARTNER
                      usage: SHARED
                      vlanAttachments:
                      - bfdEnabled: false
                        bgpPeerAsn: 9493
                        bgpPeerBfdSessionInitMode: DISABLED
                        bgpPeerMd5AuthEnabled: false
                        createTime: 1758576695376
                        edgeAvailability: AVAILABILITY_DOMAIN_1
                        id: aa465af0-d241-4097-8ee6-31b1c29924f7
                        msg: Error getting network from gcp,Not Found
                        name: test-1
                        permittedActions: []
                        stackType: IPV4_ONLY
                        state: DELETING
                        status: INACTIVE
                        tenantCount: 0
                        updateTime: 1758577091897
                      - bfdEnabled: false
                        bgpPeerAsn: 9493
                        bgpPeerBfdSessionInitMode: DISABLED
                        bgpPeerMd5AuthEnabled: false
                        createTime: 1758

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-sase-multitenant-interconnect-api-openapi-original.yml