Cisco Catalyst SD-WAN Multicloud Interconnect - Cloud Resource Management API

openapi: 3.2.0
info:
  title: SD-WAN Services Multicloud Interconnect - Cloud Resource Management API
  description: Includes API operations for managing SD-WAN services such as Cloud OnRamp for SaaS and MultiCloud
  contact:
    email: vmanage@cisco.com
  license:
    name: Commercial License
    url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html
  version: 26.1.0+2026-01-06
  x-provenance:
    method: harvested
    authored_by: Cisco Catalyst SD-WAN
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: pubhub.devnetcloud.com
    note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host.
  x-evidence:
  - type: source
    url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/
  - type: source
    url: https://developer.cisco.com/docs/sdwan/
servers:
- url: /dataservice
tags:
- name: Multicloud Interconnect - Cloud Resource Management
paths:
  /multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/gcr-and-attachments:
    get:
      tags:
      - Multicloud Interconnect - Cloud Resource Management
      summary: Get Google Cloud Router and Attachments.
      description: API to get Google Cloud Router and Attachments.
      operationId: getGoogleCloudRouterAndAttachments
      parameters:
      - name: cloud-type
        in: path
        description: Cloud Provider Type
        required: true
        schema:
          type: string
          enum:
          - AWS
          - AZURE
          - GCP
      - name: cloud-account-id
        in: path
        required: true
        schema:
          type: string
      - name: connectivity-gateway-name
        in: query
        schema:
          type: string
      - name: cloud-gateway-name
        in: query
        schema:
          type: string
      - name: region
        in: query
        schema:
          type: string
      - name: network
        in: query
        schema:
          type: string
      - name: resource-state
        in: query
        schema:
          type: string
      - name: refresh
        in: query
        schema:
          pattern: (true|false)
          type: string
          default: 'false'
      responses:
        '200':
          description: Google Cloud Router and Attachments Response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  gcpCloudRouters:
                    type: array
                    items:
                      required:
                      - name
                      - network
                      type: object
                      properties:
                        attachmentDetails:
                          type: array
                          description: List of GCR Attachments
                          items:
                            type: object
                            properties:
                              cloudRouterIpAddress:
                                type: string
                              customerIpAddress:
                                type: string
                              id:
                                type: string
                              mtu:
                                type: string
                                description: MTU of the Interconnect attachment
                                example: '1500'
                              name:
                                pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
                                type: string
                              pairingKey:
                                type: string
                                example: 96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1
                              region:
                                type: string
                              secondaryZone:
                                type: string
                                description: Option to create Interconnect attachment in secondary zone
                                example: 'true'
                              state:
                                type: string
                            description: Google cloud Interconnect Attachment Object.
                            $$ref: '#/components/schemas/GcpInterconnectAttachment'
                        cloudRouterAsn:
                          pattern: \d+
                          type: string
                        id:
                          type: string
                        name:
                          pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
                          type: string
                        network:
                          type: string
                        region:
                          type: string
                      description: Google cloud GCR Object.
                      $$ref: '#/components/schemas/GcpCloudRouter'
                $$ref: '#/components/schemas/InlineResponse20010'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/transit-gateways:
    get:
      tags:
      - Multicloud Interconnect - Cloud Resource Management
      summary: Get AWS Transit Gateways.
      description: API to retrieve AWS Transit Gateways.
      operationId: getAwsTransitGateways
      parameters:
      - name: cloud-type
        in: path
        description: Cloud Provider Type
        required: true
        schema:
          type: string
          enum:
          - AWS
      - name: cloud-account-id
        in: path
        required: true
        schema:
          maxLength: 255
          minLength: 1
          type: string
      - name: transit-gateway-name
        in: query
        schema:
          type: string
      - name: region
        in: query
        schema:
          type: string
      - name: tag-name
        in: query
        schema:
          type: string
      - name: refresh
        in: query
        schema:
          pattern: (true|false)
          type: string
          default: 'false'
      responses:
        '200':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  connectivityGateway:
                    type: array
                    items:
                      required:
                      - awsConnectivityGateway
                      - azureConnectivityGateway
                      - cloudAccountId
                      - cloudType
                      - gatewayName
                      - gcpConnectivityGateway
                      - region
                      type: object
                      properties:
                        awsConnectivityGateway:
                          required:
                          - awsConnectivityType
                          type: object
                          properties:
                            awsConnectivityType:
                              type: string
                              example: DIRECT_CONNECT_GATEWAY
                            directConnectGateway:
                              required:
                              - amazonSideAsn
                              type: object
                              properties:
                                amazonSideAsn:
                                  pattern: ^[1-9]\d*$
                                  type: string
                                gatewayAssociationList:
                                  type: array
                                  description: List of associated Gateways
                                  items:
                                    type: object
                                    properties:
                                      advertisedPrefixList:
                                        type: array
                                        description: Advertized prefix list
                                        example:
                                        - 10.10.0.0/24
                                        - 10.20.0.0/24
                                        items:
                                          type: string
                                          description: prefix
                                          example: 10.10.0.0/24
                                      associatedGateway:
                                        type: object
                                        properties:
                                          cloudAccountId:
                                            type: string
                                          cloudGatewayName:
                                            type: string
                                          cloudType:
                                            type: string
                                            enum:
                                            - AWS
                                            - AWS_GOVCLOUD
                                            - AZURE
                                            - AZURE_GOVCLOUD
                                            - GCP
                                          description:
                                            type: string
                                          gatewayId:
                                            type: string
                                          gatewayName:
                                            type: string
                                          region:
                                            type: string
                                        description: Cloud Connectivity Gateway Object
                                        $$ref: '#/components/schemas/GatewayAssociationAssociatedGateway'
                                      associationAction:
                                        type: string
                                        example: ASSOCIATE
                                        enum:
                                        - ASSOCIATE
                                        - DISASSOCIATE
                                        - REMOVE_PREFIX_LIST
                                        - NO_ACTION
                                      associationId:
                                        type: string
                                        example: '12345'
                                      associationState:
                                        type: string
                                        example: ASSOCIATED
                                      stateChangeError:
                                        type: string
                                    description: Generic multicloud gateway association object
                                    $$ref: '#/components/schemas/GatewayAssociation'
                                ownerAccount:
                                  type: string
                                virtualInterfaceAttachmentList:
                                  type: array
                                  description: List of virtual interfaces attached to DxGW
                                  items:
                                    type: object
                                    properties:
                                      attachmentState:
                                        type: string
                                      cloudType:
                                        type: string
                                        enum:
                                        - AWS
                                        - AWS_GOVCLOUD
                                        - AZURE
                                        - AZURE_GOVCLOUD
                                        - GCP
                                      connectionId:
                                        type: string
                                        description: Id of the private cross connect
                                        example: 12345-1234-1234
                                      connectionType:
                                        type: string
                                        description: Type of AWS connection
                                        example: HCONN
                                        enum:
                                        - HVIF
                                        - HCONN
                                      ownerAccount:
                                        type: string
                                      region:
                                        type: string
                                      stateChangeError:
                                        type: string
                                      virtualInterfaceData:
                                        type: object
                                        properties:
                                          advertisedPrefixList:
                                            type: array
                                            items:
                                              type: string
                                          asn:
                                            type: integer
                                            format: int64
                                            example: 65500
                                          bgpKey:
                                            type: string
                                            example: EC-12345678
                                          customerIpAddress:
                                            type: string
                                          ipAddress:
                                            type: string
                                          vlan:
                                            type: integer
                                            format: int64
                                            example: 45678
                                        description: VIrtual Interface Object
                                        $$ref: '#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceData'
                                      virtualInterfaceId:
                                        type: string
                                      virtualInterfaceName:
                                        type: string
                                      virtualInterfaceType:
                                        type: string
                                        example: TRANSIT
                                        enum:
                                        - TRANSIT
                                        - PRIVATE
                                        - PUBLIC
                                        - ATTACHMENT
                                    description: Virtual Interface Object
                                    $$ref: '#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceAttachmentList'
                                vpcTagNamesForGatewayAssociations:
                                  type: array
                                  description: VPC Tags associated to the Direct Connect Gateway
                                  items:
                                    type: string
                                    description: VPC Tags associated to the Direct Connect Gateway
                              description: AWS Direct Connect Gateway specific Object.
                              $$ref: '#/components/schemas/AwsDirectConnectGateway'
                            transitGateway:
                              required:
                              - amazonSideAsn
                              type: object
                              properties:
                                amazonSideAsn:
                                  pattern: ^[1-9]\d*$
                                  type: string
                                associationDefaultRouteTableId:
                                  type: string
                                  example: tgw-rtb-07ace6b22f9de8502
                                autoAcceptSharedAttachments:
                                  type: boolean
                                creationTime:
                                  type: string
                                  example: 11-Jun-2022 (00:10:30:00000)
                                defaultRouteTableAssociation:
                                  type: boolean
                                defaultRouteTablePropogation:
                                  type: boolean
                                dnsSupport:
                                  type: boolean
                                multicastSupport:
                                  type: boolean
                                ownerAccount:
                                  type: string
                                propogationDefaultRouteTableId:
                                  type: string
                                vpcAttachmentList:
                                  type: array
                                  description: List of VPC attachments
                                  items:
                                    type: object
                                    properties:
                                      region:
                                        type: string
                                      vpcId:
                                        type: string
                                        description: VPC Id
                                        example: vpc-012345-2000
                                      vpcRoutePrefixList:
                                        type: array
                                        description: List of ip prefixes to be advertized towards DxGw on the VPC routing table.
                                        example:
                                        - 198.18.0.4/30
                                        - 198.18.0.7/30
                                        items:
                                          type: string
                                          description: ip prefix
                                          example: 198.18.0.4/30
                                      vpcState:
                                        type: string
                                      vpcSubnetPrefixList:
                                        type: array
                                        description: List of VPC subnets to be added to DxGw association
                                        example:
                                        - 10.10.0.0/24
                                        - 10.10.1.0/24
                                        items:
                                          type: string
                                          description: VPC subnet
                                          example: 10.10.0.0/24
                                    description: AWS VPC attachment Object
                                    $$ref: '#/components/schemas/AwsVpcAttachments'
                                vpnEcmpSupport:
                                  type: boolean
                              description: AWS Transit Gateway specific Object.
                              $$ref: '#/components/schemas/AwsTransitGateway'
                            virtualPrivateGateway:
                              type: object
                              properties:
                                amazonSideAsn:
                                  type: integer
                                  format: int64
                                availabilityZone:
                                  type: string
                                vpcAttachmentList:
                                  type: array
                                  description: List of VPC attachments
                                  items:
                                    type: object
                                    properties:
                                      region:
                                        type: string
                                      vpcId:
                                        type: string
                                        description: VPC Id
                                        example: vpc-012345-2000
                                      vpcRoutePrefixList:
                                        type: array
                                        description: List of ip prefixes to be advertized towards DxGw on the VPC routing table.
                                        example:
                                        - 198.18.0.4/30
                                        - 198.18.0.7/30
                                        items:
                                          type: string
                                          description: ip prefix
                                          example: 198.18.0.4/30
                                      vpcState:
                                        type: string
                                      vpcSubnetPrefixList:
                                        type: array
                                        description: List of VPC subnets to be added to DxGw association
                                        example:
                                        - 10.10.0.0/24
                                        - 10.10.1.0/24
                                        items:
                                          type: string
                                          description: VPC subnet
                                          example: 10.10.0.0/24
                                    description: AWS VPC attachment Object
                                    $$ref: '#/components/schemas/AwsVpcAttachments'
                                vpgType:
                                  type: string
                                  example: ipsec.1
                              description: AWS Virtual Private Gateway specific Object.
                              $$ref: '#/components/schemas/AwsVirtualPrivateGateway'
                          description: AWS cloud Connectivity Gateway Object
                          $$ref: '#/components/schemas/CloudConnectivityGatewayAws'
                        azureConnectivityGateway:
                          required:
                          - azureConnectivityType
                          type: object
                          properties:
                            azureConnectivityType:
                              type: string
                            expressRouteCircuit:
                              required:
                              - resourceGroupName
                              type: object
                              properties:
                                allowClassicOperations:
                                  type: boolean
                                  example: true
                                bandwidthInGbps:
                                  type: integer
                                  format: int32
                                  example: 200
                                gatewayAssociationList:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      advertisedPrefixList:
                                        type: array
                                        description: Advertized prefix list
                                        example:
                                        - 10.10.0.0/24
                                        - 10.20.0.0/24
                                        items:
                                          type: string
                                          description: prefix
                                          example: 10.10.0.0/24
                                      associatedGateway:
                                        type: object
                                        properties:
                                          cloudAccountId:
                                            type: string
                                          cloudGatewayName:
                                            type: string
                                          cloudType:
                                            type: string
                                            enum:
                                            - AWS
                                            - AWS_GOVCLOUD
                                            - AZURE
                                            - AZURE_GOVCLOUD
                                            - GCP
                                          description:
                                            type: string
                                          gatewayId:
                                            type: string
                                          gatewayName:
                                            type: string
                                          region:
                                            type: string
                                        description: Cloud Connectivity Gateway Object
                                        $$ref: '#/components/schemas/GatewayAssociationAssociatedGateway'
                                      associationAction:
                                        type: string
                                        example: ASSOCIATE
                                        enum:
                                        - ASSOCIATE
                                        - DISASSOCIATE
                                        - REMOVE_PREFIX_LIST
                                        - NO_ACTION
                                      associationId:
                                        type: string
                                        example: '12345'
                                      associationState:
                                        type: string
                                        example: ASSOCIATED
                                      stateChangeError:
                                        type: string
                                    description: Generic multicloud gateway association object
                                    $$ref: '#/components/schemas/GatewayAssociation'
                                globalReachEnabled:
                                  type: boolean
                                  example: true
                                peeringList:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      advertisedPublicPrefixList:
                                        type: array
                                        items:
                                          type: string
                                      azureAsn:
                                        type: string
                                      expressRouteConnectionId:
                                        type: string
                                        example: '12345'
                                      id:
                                        type: string
                                      name:
                                        type: string
                                      peerAsn:
                                        type: string
                                      peeringState:
                                        type: string
                                        example: ENABLED
                                        enum:
                                        - DISABLED
                                        - ENABLED
                                      peeringType:
                                        type: string
                                        example: PUBLIC
                                        enum:
                                        - PRIVATE
                                        - PUBLIC
                                      primaryAzurePort:
                                        type: string
                                      primaryPeerAddressPrefix:
                                        type: string
                                      secondaryAzurePort:
                                        type: string
                                      secondaryPeerAddressPrefix:
                                        type: string
                                      sharedKey:
                                        type: string
                                        description: BGP Peering Key
                                        example: EC-12345
                                      vlanId:
                                        type: integer
                                        format: int64
                                        example: 1618
                                    description: Azure Express Route Circuit Peering
                                    $$ref: '#/components/schemas/AzureERCPeering'
                                provisioningState:
                                  type: string
                                  example: PROVISIONED
                                resourceGroupName:
                                  type: string
                                serviceKey:
                                  type: string
                                serviceProviderProperties:
                                  type: object
                                  properties:
                                    bandwidthInMbps:
                                      type: integer
                                      format: int64
                                      example: 1000
                                    peeringLocation:
                                      type: string
                                      example: New York
                                    serviceProviderName:
                                      type: string
                                  description: Azure Express Route Circuit Service Provider Properties
                                  $$ref: '#/components/schemas/AzureERCServiceProviderProperties'
                                serviceProviderProvisioningState:
                                  type: string
                                  enum:
                                  - DEPROVISIONING
                                  - NOT_PROVISIONED
                                  - PROVISIONED
                                  - PROVISIONING
                                sku:
                                  required:
                                  - family
                                  - tier
                                  type: object
                                  properties:
                                    family:
                                      type: string
                                    name:
                                      type: string
                                    tier:
                                      type: string
                                      example: STANDARD
                                  description: Express Route Circuit SKU
                                  $$ref: '#/components/schemas/AzureExpressRouteCircuitSku'
                                vWanAttachmentList:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      vHubList:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            isDelete:
                                              type: boolean
              

# --- truncated at 32 KB (152 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-multicloud-interconnect-cloud-resource-management-api-openapi.yml