openapi: 3.2.0 info: title: SD-WAN Services Multicloud Interconnect - Connectivity 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 - Connectivity paths: /multicloud/interconnect/connectivity/cloud-onramp-gateway-connections: get: tags: - Multicloud Interconnect - Connectivity summary: Retrieve an Interconnect OnRamp gateway connection. description: API to retrieve all Interconnect OnRamp gateway connection. operationId: getInterconnectOnRampGatewayConnections parameters: - name: cloud-type in: query description: Cloud provider type schema: pattern: ^(AWS|AZURE|GCP)$ type: string - name: cloud-account-id in: query description: Cloud account id schema: maxLength: 255 minLength: 1 type: string - name: connection-name in: query description: Interconnect OnRamp gateway connection name schema: pattern: ^[\w.:-]{1,256}$ type: string - name: refresh in: query description: Interconnect connection provider sync enabled schema: pattern: (true|false) type: string default: 'false' responses: '200': description: Get all Interconnect OnRamp gateway connections content: application/json: schema: type: object '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Multicloud Interconnect - Connectivity summary: Create an Interconnect OnRamp gateway connection. description: API to create an Interconnect OnRamp gateway connection. operationId: createInterconnectOnRampGatewayConnection requestBody: description: Request payload for Interconnect OnRamp gateway connection content: application/json: schema: type: array items: type: object properties: valueType: type: string enum: - ARRAY - OBJECT - STRING - NUMBER - 'TRUE' - 'FALSE' - 'NULL' required: true responses: '200': description: Create a Interconnect OnRamp gateway connection. content: application/json: schema: type: array items: required: - cloudAccessType - cloudAccountId - cloudAccountName - cloudType - connectionId - connectionName type: object properties: cloudAccessType: type: string description: Interconnect cloud connect cloud access type cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect OnRamp gateway connection cloud connect cloud account id cloudAccountName: type: string description: Interconnect OnRamp gateway connection cloud connect cloud account id cloudType: type: string description: Interconnect OnRamp gateway connection cloud connect cloud provider type connectionId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect OnRamp gateway connection id connectionName: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect OnRamp gateway connection name description: type: string description: Interconnect OnRamp gateway optional description directConnectGatewayDetails: required: - cloudResourceId type: object properties: cloudResourceId: maxLength: 255 minLength: 1 pattern: ^.+:{2}.+$ type: string description: Interconnect OnRamp AWS Direct Connect Gateway cloud resource id id: type: string description: Interconnect On Ramp AWS Direct Connect Gateway cloud resource id name: type: string description: Interconnect On Ramp AWS Direct Connect Gateway cloud resource name description: Interconnect OnRamp gateway connection Direct connect gateway details $$ref: '#/components/schemas/DirectConnectGatewayDetails' expressRouteCircuitDetails: required: - cloudResourceId type: object properties: cloudResourceId: maxLength: 255 minLength: 1 type: string description: Interconnect OnRamp Azure express route circuit cloud resource id id: type: string description: Interconnect OnRamp Azure express route circuit id name: type: string description: Interconnect OnRamp Azure express route circuit name resourceGroupName: type: string description: Interconnect OnRamp Azure express route circuit resource group serviceKey: type: string description: Interconnect OnRamp Azure express route circuit service key description: Interconnect OnRamp gateway connection Express route circuit details $$ref: '#/components/schemas/ExpressRouteCircuitDetails' gatewayAssociations: type: array description: Interconnect OnRamp gateway connection gateway associations items: required: - resourceType type: object properties: cgwDetails: required: - cloudAccountId - name type: object properties: advertisedPrefixes: type: array description: Interconnect on ramp gateway connection cgw advertised prefixes items: type: string description: Interconnect on ramp gateway connection cgw advertised prefixes cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect On Ramp Gateway connection cloud connect cloud account id id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect OnRamp gateway associated cgw gateway id name: type: string description: Interconnect OnRamp gateway associated cgw gateway name description: Interconnect OnRamp gateway association MultiCloud gateway details $$ref: '#/components/schemas/CgwDetails' resourceType: type: string description: Interconnect OnRamp gateway association type tgwDetails: required: - advertisedPrefixes - cloudAccountId - isCreate type: object properties: advertisedPrefixes: type: array description: Prefixes to be advertised to the Direct Connect Gateway items: type: string description: Prefixes to be advertised to the Direct Connect Gateway bgpAsn: pattern: \d+ type: string description: Transit Gateway cloud side BGP ASN cloudAccountId: maxLength: 255 minLength: 1 type: string description: Transit gateway cloud account id cloudResourceId: pattern: ^.+:{2}.+$ type: string description: Transit gateway cloud resource id create: type: boolean id: type: string description: Transit gateway id isCreate: pattern: (true|false) type: string description: Transit gateway create flag name: type: string description: Transit gateway name region: type: string description: Transit gateway region description: Interconnect OnRamp gateway association Transit gateway details $$ref: '#/components/schemas/TgwDetails' vhubDetails: required: - addressPrefix - cloudAccountId - isCreate type: object properties: addressPrefix: pattern: ^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\/(?:3[0-2]|[0-2]?[0-9])$ type: string description: Virtual hub gateway address prefix cloudAccountId: maxLength: 255 minLength: 1 type: string description: Virtual hub gateway cloud account id cloudResourceId: pattern: ^.+:{2}.+$ type: string description: Virtual hub gateway cloud resource id create: type: boolean id: type: string description: Virtual hub gateway id isCreate: pattern: (true|false) type: string description: Virtual hub gateway create flag name: type: string description: Virtual hub gateway name region: type: string description: Virtual hub gateway region resourceGroupName: type: string description: Virtual hub gateway resource group description: Interconnect OnRamp gateway association Virtual hub details $$ref: '#/components/schemas/VhubDetails' description: Interconnect OnRamp gateway connection gateway associations $$ref: '#/components/schemas/GatewayAssociationDetail' googleCloudRouterDetails: type: array description: Interconnect OnRamp gateway connection Google cloud router details items: required: - cloudResourceId - role type: object properties: cloudResourceId: maxLength: 255 minLength: 1 pattern: ^.+:{2}.+$ type: string description: Interconnect OnRamp Google cloud router & attachment cloud resource id googleAttachmentDetail: type: string description: Interconnect OnRamp Google cloud router attachment detail id: type: string description: Interconnect OnRamp Google cloud router id name: type: string description: Interconnect OnRamp Google cloud router name network: type: string description: Interconnect OnRamp Google cloud router network region: type: string description: Interconnect OnRamp Google cloud router region role: type: string description: Interconnect OnRamp Google cloud router & attachment role description: Interconnect OnRamp gateway connection Google cloud router details $$ref: '#/components/schemas/GoogleCloudRouterDetails' interconnectAttachments: type: array description: Interconnect OnRamp gateway connection interconnect attachments items: required: - resourceType type: object properties: connectionDetails: required: - connectionName type: object properties: connectionName: maxLength: 255 minLength: 1 type: string description: Interconnect cross connection name description: Interconnect cross connection attachment connection details $$ref: '#/components/schemas/ConnectionDetail' resourceType: type: string description: Interconnect cross connection attachment resource type description: Interconnect OnRamp gateway connection interconnect attachments $$ref: '#/components/schemas/InterconnectAttachments' interconnectResourceState: type: object properties: resourceAssociationDetails: type: array items: type: object properties: associatedResourceConnectionStatus: type: string associatedResourceId: type: string associatedResourceName: type: string associatedResourceStatus: type: string associatedResourceType: type: string $$ref: '#/components/schemas/ResourceAssociationDetail' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string description: Interconnect virtual network connection resource state information $$ref: '#/components/schemas/InterconnectResourceState' onRampGatewayType: type: string description: Interconnect cloud connect cloud access type virtualNetworkAssociationType: type: string description: Interconnect cloud connect virtual network association type virtualWanDetails: required: - cloudResourceId type: object properties: cloudResourceId: maxLength: 255 minLength: 1 type: string description: Interconnect OnRamp Azure virtual wan cloud resource id id: type: string description: Interconnect OnRamp Azure virtual wan id name: type: string description: Interconnect OnRamp Azure virtual wan name resourceGroupName: type: string description: Interconnect OnRamp Azure virtual wan resource group description: Interconnect OnRamp gateway connection Azure virtual wan details $$ref: '#/components/schemas/VirtualWanDetails' $$ref: '#/components/schemas/InterconnectOnRampGatewayConnection' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/cloud-onramp-gateway-connections/{connection-name}: delete: tags: - Multicloud Interconnect - Connectivity summary: Delete an Interconnect OnRamp gateway connection. description: API to delete an Interconnect OnRamp gateway connection. operationId: deleteInterconnectOnRampGatewayConnection parameters: - name: connection-name in: path description: Interconnect OnRamp gateway connection name required: true schema: pattern: ^[\w.:-]{1,256}$ type: string - name: delete-cloud-resources in: query description: Interconnect connection provider sync enabled schema: pattern: (true|false) type: string default: 'false' responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error get: tags: - Multicloud Interconnect - Connectivity summary: Get OnRamp gateway connection by name. description: API to retrieve a specific Interconnect OnRamp gateway connection. operationId: getInterconnectOnRampGatewayConnection parameters: - name: connection-name in: path description: Interconnect OnRamp gateway connection name required: true schema: pattern: ^[\w.:-]{1,256}$ type: string responses: '200': description: Get an Interconnect OnRamp gateway connection content: application/json: schema: required: - cloudAccessType - cloudAccountId - cloudAccountName - cloudType - connectionId - connectionName type: object properties: cloudAccessType: type: string description: Interconnect cloud connect cloud access type cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect OnRamp gateway connection cloud connect cloud account id cloudAccountName: type: string description: Interconnect OnRamp gateway connection cloud connect cloud account id cloudType: type: string description: Interconnect OnRamp gateway connection cloud connect cloud provider type connectionId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect OnRamp gateway connection id connectionName: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect OnRamp gateway connection name description: type: string description: Interconnect OnRamp gateway optional description directConnectGatewayDetails: required: - cloudResourceId type: object properties: cloudResourceId: maxLength: 255 minLength: 1 pattern: ^.+:{2}.+$ type: string description: Interconnect OnRamp AWS Direct Connect Gateway cloud resource id id: type: string description: Interconnect On Ramp AWS Direct Connect Gateway cloud resource id name: type: string description: Interconnect On Ramp AWS Direct Connect Gateway cloud resource name description: Interconnect OnRamp gateway connection Direct connect gateway details $$ref: '#/components/schemas/DirectConnectGatewayDetails' expressRouteCircuitDetails: required: - cloudResourceId type: object properties: cloudResourceId: maxLength: 255 minLength: 1 type: string description: Interconnect OnRamp Azure express route circuit cloud resource id id: type: string description: Interconnect OnRamp Azure express route circuit id name: type: string description: Interconnect OnRamp Azure express route circuit name resourceGroupName: type: string description: Interconnect OnRamp Azure express route circuit resource group serviceKey: type: string description: Interconnect OnRamp Azure express route circuit service key description: Interconnect OnRamp gateway connection Express route circuit details $$ref: '#/components/schemas/ExpressRouteCircuitDetails' gatewayAssociations: type: array description: Interconnect OnRamp gateway connection gateway associations items: required: - resourceType type: object properties: cgwDetails: required: - cloudAccountId - name type: object properties: advertisedPrefixes: type: array description: Interconnect on ramp gateway connection cgw advertised prefixes items: type: string description: Interconnect on ramp gateway connection cgw advertised prefixes cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect On Ramp Gateway connection cloud connect cloud account id id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect OnRamp gateway associated cgw gateway id name: type: string description: Interconnect OnRamp gateway associated cgw gateway name description: Interconnect OnRamp gateway association MultiCloud gateway details $$ref: '#/components/schemas/CgwDetails' resourceType: type: string description: Interconnect OnRamp gateway association type tgwDetails: required: - advertisedPrefixes - cloudAccountId - isCreate type: object properties: advertisedPrefixes: type: array description: Prefixes to be advertised to the Direct Connect Gateway items: type: string description: Prefixes to be advertised to the Direct Connect Gateway bgpAsn: pattern: \d+ type: string description: Transit Gateway cloud side BGP ASN cloudAccountId: maxLength: 255 minLength: 1 type: string description: Transit gateway cloud account id cloudResourceId: pattern: ^.+:{2}.+$ type: string description: Transit gateway cloud resource id create: type: boolean id: type: string description: Transit gateway id isCreate: pattern: (true|false) type: string description: Transit gateway create flag name: type: string description: Transit gateway name region: type: string description: Transit gateway region description: Interconnect OnRamp gateway association Transit gateway details $$ref: '#/components/schemas/TgwDetails' vhubDetails: required: - addressPrefix - cloudAccountId - isCreate type: object properties: addressPrefix: pattern: ^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\/(?:3[0-2]|[0-2]?[0-9])$ type: string description: Virtual hub gateway address prefix cloudAccountId: maxLength: 255 minLength: 1 type: string description: Virtual hub gateway cloud account id cloudResourceId: pattern: ^.+:{2}.+$ type: string description: Virtual hub gateway cloud resource id create: type: boolean id: type: string description: Virtual hub gateway id isCreate: pattern: (true|false) type: string description: Virtual hub gateway create flag name: type: string description: Virtual hub gateway name region: type: string description: Virtual hub gateway region resourceGroupName: type: string description: Virtual hub gateway resource group description: Interconnect OnRamp gateway association Virtual hub details $$ref: '#/components/schemas/VhubDetails' description: Interconnect OnRamp gateway connection gateway associations $$ref: '#/components/schemas/GatewayAssociationDetail' googleCloudRouterDetails: type: array description: Interconnect OnRamp gateway connection Google cloud router details items: required: - cloudResourceId - role type: object properties: cloudResourceId: maxLength: 255 minLength: 1 pattern: ^.+:{2}.+$ type: string description: Interconnect OnRamp Google cloud router & attachment cloud resource id googleAttachmentDetail: type: string description: Interconnect OnRamp Google cloud router attachment detail id: type: string description: Interconnect OnRamp Google cloud router id name: type: string description: Interconnect OnRamp Google cloud router name network: type: string description: Interconnect OnRamp Google cloud router network region: type: string description: Interconnect OnRamp Google cloud router region role: type: string description: Interconnect OnRamp Google cloud router & attachment role description: Interconnect OnRamp gateway connection Google cloud router details $$ref: '#/components/schemas/GoogleCloudRouterDetails' interconnectAttachments: type: array description: Interconnect OnRamp gateway connection interconnect attachments items: required: - resourceType type: object properties: connectionDetails: required: - connectionName type: object properties: connectionName: maxLength: 255 minLength: 1 type: string description: Interconnect cross connection name description: Interconnect cross connection attachment connection details $$ref: '#/components/schemas/ConnectionDetail' resourceType: type: string description: Interconnect cross connection attachment resource type description: Interconnect OnRamp gateway connection interconnect attachments $$ref: '#/components/schemas/InterconnectAttachments' interconnectResourceState: type: object properties: resourceAssociationDetails: type: array items: type: object properties: associatedResourceConnectionStatus: type: string associatedResourceId: type: string associatedResourceName: type: string associatedResourceStatus: type: string associatedResourceType: type: string $$ref: '#/components/schemas/ResourceAssociationDetail' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string description: Interconnect virtual network connection resource state information $$ref: '#/components/schemas/InterconnectResourceState' onRampGatewayType: type: string description: Interconnect cloud connect cloud access type virtualNetworkAssociationType: type: string description: Interconnect cloud connect virtual network association type virtualWanDetails: required: - cloudResourceId type: object properties: cloudResourceId: maxLength: 255 minLength: 1 type: string description: Interconnect OnRamp Azure virtual wan cloud resource id id: type: string description: Interconnect OnRamp Azure virtual wan id name: type: string description: Interconnect OnRamp Azure virtual wan name resourceGroupName: type: string description: Interconnect OnRamp Azure virtual wan resource group description: Interconnect OnRamp gateway connection Azure virtual wan details $$ref: '#/components/schemas/VirtualWanDetails' $$ref: '#/components/schemas/InterconnectOnRampGatewayConnection' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error put: tags: - Multicloud Interconnect - Connectivity summary: Update an Interconnect OnRamp Gateway Connection. description: API to update an Interconnect OnRamp gateway connection. operationId: updateInterconnectOnRampGatewayConnection parameters: - name: connection-name in: path description: Interconnect OnRamp gateway connection name required: true schema: pattern: ^[\w.:-]{1,256}$ type: string requestBody: description: Request payload for Interconnect OnRamp gateway connection content: application/json: schema: type: object additionalProperties: type: object properties: valueType: type: string enum: - ARRAY - OBJECT - STRING - NUMBER - 'TRUE' - 'FALSE' - 'NULL' required: true responses: '200': description: Update an Interconnect OnRamp gateway connection content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/cloud-onramp-gateway-connections/{connection-name}/resources: get: tags: - Multicloud Interconnect - Connectivity summary: Get OnRamp gateway connection resources. description: API to retrieve all resources used by a specific Interconnect OnRamp gateway connection. operationId: getInterconnectOnRampGatewayConnectionResources parameters: - name: connection-name in: path description: Interconnect OnRamp gateway connection name required: true schema: pattern: ^[\w.:-]{1,256}$ type: string - name: refresh in: query description: Retrieve and update all cloud resource state schema: pattern: (true|false) type: string default: 'false' responses: '200': description: Interconnect OnRamp gateway connection associated resources content: application/json: schema: type: object '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/connections/tags: get: tags: - Multicloud Interconnect - Connectivity summary: Get configured Interconnect host VPC/VNET mapping tags. description: API to retrieve configured Interconnect host VPC/VNET mapping tags. operationId: getInterconnectMappingTags parameters: - name: cloud-type in: query description: Cloud provider type required: true schema: type: string - name: cloud-account-id in: query description: Cloud account id required: true schema: maxLength: 255 minLength: 1 type: string - name: resource-group in: query description: Azure cloud resource group name schema: maxLength: 128 minLength: 1 type: string responses: '200': description: Accepted content: application/json: schema: type: object properties: loopbackCgwColor: type: array description: Loopback cgw color list example: - gold - biz-internet - private1 - private2 items: type: string description: Loopback cgw color example: gold loopbackTunnelColor: type: array description: Loopback tunnel color list example: - gold - biz-internet - private1 - private2 items: type: string description: Loopback tunnel color example: gold $$ref: '#/components/schemas/InlineResponse2002' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/device-links: get: tags: - Multicloud Interconnect - Connectivity summary: Get Interconnect provider Device-Link. description: API to retrieve Interconnect provider Device-Link. operationId: getInterconnectDeviceLinks parameters: - name: device-link-name in: query description: Interconnect Device Link name schema: pattern: ^[\w.-]{3,50}$ type: string - name: interconnect-type in: query description: Interconnect Provider Type schema: type: string enum: - MEGAPORT - EQUINIX - name: refresh in: query description: Retrieve Interconnect Device-Link from provider enabled schema: pattern: (true|false) type: string default: 'false' responses: '200': description: Interconnect Device-Link Get Response. content: application/json: schema: required: - bandwidth - deviceLinkName - edgeAccountId - edgeType type: object properties: bandwidth: type: string description: Device-Link Bandwidth Input. example: '50' deviceLinkName: maxLength: 50 minLength: 3 pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Device-Link. example: my-device-link deviceLinkUuid: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Uuid of the Interconnect Device-Link example: 496bddbd-e104-44a7-ba62-7a285f642304 deviceLinksubnet: type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 deviceList: maxItems: 2147483647 minItems: 2 type: array items: type: object properties: deviceInterfaceId: type: string description: Interface used on the Interconnect Gateway to connect to the Device-Link. example: GigabitEthernet4 deviceIntfIpAddress: type: string description: IP assigned to the Interconnect Gateway interface to connect to the Device-Link. example: 20.10.0.2 deviceName: pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Gateway in the Device-Link. example: ICGW_1 deviceUuid: type: string description: Uuid of Interconnect Gateway in the Device-Link. example: 0dc43131-47c9-4fce-8499-f02e3340c9fb egwLoopBackCidr: type: string description: IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel. example: 172.31.251.8/30 $$ref: '#/components/schemas/InterconnectDeviceLinkDeviceList' dlMetroBandwidth: type: string description: Device-Link Bandwidth at a given Metro. example: '150' edgeAccountId: maxLength: 255 minLength: 1 type: string edgeAccountName: maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_\-\s]+$ type: string edgeType: type: string linkBandwidth: type: string description: Device-Link Bandwidth. example: '50' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string subnet: pattern: ^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\/(?:3[0-2]|[0-2]?[0-9])$ type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 version: type: string description: Version of the payload. example: '1' description: Interconnect Device-Link Object $$ref: '#/components/schemas/InterconnectDeviceLink' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Multicloud Interconnect - Connectivity summary: Add an Interconnect Device-Link to vManage. description: API to create a Device-Link in vManage. operationId: addInterconnectDeviceLink requestBody: description: Request Payload for Multicloud Interconnect Device Links content: application/json: schema: required: - bandwidth - deviceLinkName - edgeAccountId - edgeType type: object properties: bandwidth: type: string description: Device-Link Bandwidth Input. example: '50' deviceLinkName: maxLength: 50 minLength: 3 pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Device-Link. example: my-device-link deviceLinkUuid: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Uuid of the Interconnect Device-Link example: 496bddbd-e104-44a7-ba62-7a285f642304 deviceLinksubnet: type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 deviceList: maxItems: 2147483647 minItems: 2 type: array items: type: object properties: deviceInterfaceId: type: string description: Interface used on the Interconnect Gateway to connect to the Device-Link. example: GigabitEthernet4 deviceIntfIpAddress: type: string description: IP assigned to the Interconnect Gateway interface to connect to the Device-Link. example: 20.10.0.2 deviceName: pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Gateway in the Device-Link. example: ICGW_1 deviceUuid: type: string description: Uuid of Interconnect Gateway in the Device-Link. example: 0dc43131-47c9-4fce-8499-f02e3340c9fb egwLoopBackCidr: type: string description: IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel. example: 172.31.251.8/30 $$ref: '#/components/schemas/InterconnectDeviceLinkDeviceList' dlMetroBandwidth: type: string description: Device-Link Bandwidth at a given Metro. example: '150' edgeAccountId: maxLength: 255 minLength: 1 type: string edgeAccountName: maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_\-\s]+$ type: string edgeType: type: string linkBandwidth: type: string description: Device-Link Bandwidth. example: '50' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string subnet: pattern: ^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\/(?:3[0-2]|[0-2]?[0-9])$ type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 version: type: string description: Version of the payload. example: '1' description: Interconnect Device-Link Object $$ref: '#/components/schemas/InterconnectDeviceLink' examples: Interconnect Equinix Device Link: description: Interconnect Equinix Device Link value: edgeType: EQUINIX edgeAccountId: ABCD-1234-CDEF edgeAccountName: interconnect-account-name deviceLinkName: my-device-link subnet: 20.10.0.0/16 bandwidth: '100' deviceList: - deviceName: ICGW_1 - deviceName: ICGW_2 required: true responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/device-links/{device-link-name}: get: tags: - Multicloud Interconnect - Connectivity summary: Get Interconnect provider Device-Link. description: API to retrieve Interconnect provider Device-Link. operationId: getInterconnectDeviceLink parameters: - name: device-link-name in: path description: Interconnect Device Link name required: true schema: pattern: ^[\w.-]{3,50}$ type: string responses: '200': description: Interconnect Device-Link Get Response. content: application/json: schema: required: - bandwidth - deviceLinkName - edgeAccountId - edgeType type: object properties: bandwidth: type: string description: Device-Link Bandwidth Input. example: '50' deviceLinkName: maxLength: 50 minLength: 3 pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Device-Link. example: my-device-link deviceLinkUuid: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Uuid of the Interconnect Device-Link example: 496bddbd-e104-44a7-ba62-7a285f642304 deviceLinksubnet: type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 deviceList: maxItems: 2147483647 minItems: 2 type: array items: type: object properties: deviceInterfaceId: type: string description: Interface used on the Interconnect Gateway to connect to the Device-Link. example: GigabitEthernet4 deviceIntfIpAddress: type: string description: IP assigned to the Interconnect Gateway interface to connect to the Device-Link. example: 20.10.0.2 deviceName: pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Gateway in the Device-Link. example: ICGW_1 deviceUuid: type: string description: Uuid of Interconnect Gateway in the Device-Link. example: 0dc43131-47c9-4fce-8499-f02e3340c9fb egwLoopBackCidr: type: string description: IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel. example: 172.31.251.8/30 $$ref: '#/components/schemas/InterconnectDeviceLinkDeviceList' dlMetroBandwidth: type: string description: Device-Link Bandwidth at a given Metro. example: '150' edgeAccountId: maxLength: 255 minLength: 1 type: string edgeAccountName: maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_\-\s]+$ type: string edgeType: type: string linkBandwidth: type: string description: Device-Link Bandwidth. example: '50' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string subnet: pattern: ^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\/(?:3[0-2]|[0-2]?[0-9])$ type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 version: type: string description: Version of the payload. example: '1' description: Interconnect Device-Link Object $$ref: '#/components/schemas/InterconnectDeviceLink' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error put: tags: - Multicloud Interconnect - Connectivity summary: Update an Interconnect Device-Link to vManage. description: API to update a Device-Link in vManage. operationId: updateInterconnectDeviceLink parameters: - name: device-link-name in: path description: Interconnect Device Link name required: true schema: pattern: ^[\w.-]{3,50}$ type: string requestBody: description: Request Payload for Multicloud Interconnect Device Links content: application/json: schema: required: - bandwidth - deviceLinkName - edgeAccountId - edgeType type: object properties: bandwidth: type: string description: Device-Link Bandwidth Input. example: '50' deviceLinkName: maxLength: 50 minLength: 3 pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Device-Link. example: my-device-link deviceLinkUuid: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Uuid of the Interconnect Device-Link example: 496bddbd-e104-44a7-ba62-7a285f642304 deviceLinksubnet: type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 deviceList: maxItems: 2147483647 minItems: 2 type: array items: type: object properties: deviceInterfaceId: type: string description: Interface used on the Interconnect Gateway to connect to the Device-Link. example: GigabitEthernet4 deviceIntfIpAddress: type: string description: IP assigned to the Interconnect Gateway interface to connect to the Device-Link. example: 20.10.0.2 deviceName: pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Gateway in the Device-Link. example: ICGW_1 deviceUuid: type: string description: Uuid of Interconnect Gateway in the Device-Link. example: 0dc43131-47c9-4fce-8499-f02e3340c9fb egwLoopBackCidr: type: string description: IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel. example: 172.31.251.8/30 $$ref: '#/components/schemas/InterconnectDeviceLinkDeviceList' dlMetroBandwidth: type: string description: Device-Link Bandwidth at a given Metro. example: '150' edgeAccountId: maxLength: 255 minLength: 1 type: string edgeAccountName: maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_\-\s]+$ type: string edgeType: type: string linkBandwidth: type: string description: Device-Link Bandwidth. example: '50' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string subnet: pattern: ^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\/(?:3[0-2]|[0-2]?[0-9])$ type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 version: type: string description: Version of the payload. example: '1' description: Interconnect Device-Link Object $$ref: '#/components/schemas/InterconnectDeviceLink' examples: Interconnect Equinix Device Link: description: Interconnect Equinix Device Link value: edgeType: EQUINIX edgeAccountId: ABCD-1234-CDEF edgeAccountName: interconnect-account-name deviceLinkName: my-device-link subnet: 20.10.0.0/16 bandwidth: '100' deviceList: - deviceName: ICGW_1 - deviceName: ICGW_2 required: true responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error delete: tags: - Multicloud Interconnect - Connectivity summary: Delete Interconnect provider Device-Link. description: API to Delete Interconnect provider Device-Link. operationId: deleteInterconnectDeviceLink parameters: - name: device-link-name in: path description: Interconnect Device Link name required: true schema: pattern: ^[\w.-]{3,50}$ type: string responses: '200': description: Accepted '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/virtual-cross-connections: get: tags: - Multicloud Interconnect - Connectivity summary: Retrieve all Interconnect virtual cross connections. description: API to retrieve all exisiting Interconnect virtual cross connections. operationId: getInterconnectCrossConnections parameters: - name: interconnect-type in: query description: Interconnect provider Type schema: type: string - name: interconnect-gateway-name in: query description: Interconnect gateway name schema: maxLength: 255 minLength: 1 type: string - name: connection-name in: query description: Interconnect virtual cross connection name schema: maxLength: 255 minLength: 1 type: string - name: connection-type in: query description: Interconnect virtual cross connection type schema: type: string - name: cloud-type in: query description: Cloud provider type schema: pattern: ^(AWS|AZURE|GCP)$ type: string - name: refresh in: query description: Interconnect connection provider sync enabled schema: pattern: (true|false) type: string default: 'false' responses: '200': description: Accepted content: application/json: schema: type: object '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Multicloud Interconnect - Connectivity summary: Create private Interconnect cross connection. description: API to create an Interconnect virtual cross connection on an Interconnect Gateway at an Interconnect Provider. operationId: createInterconnectCrossConnection requestBody: description: Request Payload for Interconnect virtual cross connections content: application/json: schema: type: array items: required: - connectionId - connectionName - connectionRole - connectionSpeed - connectionType - interconnectAccountId - interconnectType type: object properties: cloudConnectDetail: required: - cloudAccessType - cloudType - connectionDestination - connectionSource - peeringInfo type: object properties: awsCloudDetail: required: - cloudAccountId - cloudAccountName - crossConnectType type: object properties: cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect cloud connect AWS cloud account id cloudAccountName: type: string description: Interconnect cloud connect cloud account name cloudSideBgpAsn: pattern: \d+ type: string description: Interconnect cloud connect AWS cloud side BGP ASN crossConnectType: pattern: ^(HVIF|HCONN)$ type: string description: Interconnect cloud connect AWS cross connect type hostedConnectionId: type: string description: Interconnect cloud connect AWS hosted connection id virtualInterfaceId: type: string description: Interconnect cloud connect AWS hosted virtual interface id description: Interconnect cloud connect AWS cloud detail $$ref: '#/components/schemas/AwsCloudDetail' azureCloudDetail: required: - cloudAccountId - cloudAccountName - crossConnectType - serviceKey type: object properties: cloudAccountId: type: string description: Interconnect cloud connect Azure cloud account id cloudAccountName: type: string description: Interconnect cloud connect cloud account name crossConnectType: pattern: ^EXPRESS_ROUTE_CIRCUIT$ type: string description: Interconnect cloud connect Azure cross connect type serviceKey: maxLength: 255 minLength: 1 type: string description: Interconnect cloud connect Azure Express Route Circuit service key description: Interconnect cloud connect Azure cloud detail $$ref: '#/components/schemas/AzureCloudDetail' cloudAccessType: type: string description: Interconnect cloud connect cloud access type cloudType: type: string description: Interconnect cloud connect cloud provider type connectionDestination: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' connectionSource: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' googleCloudDetail: required: - cloudAccountName - crossConnectType - pairingKey type: object properties: cloudAccountId: type: string description: Google cloud account id cloudAccountName: type: string description: Interconnect cloud connect cloud account name crossConnectType: pattern: ^GCR_ATTACHMENT$ type: string description: Google cross connect type pairingKey: maxLength: 255 minLength: 1 type: string description: Google GCR attachment pairing key description: Interconnect cloud connect Google cloud detail $$ref: '#/components/schemas/GoogleCloudDetail' peeringInfo: required: - peeringType - vpnSegment type: object properties: customPeeringInfo: type: object properties: advertisedPrefixes: type: array description: Custom prefixes to be advertised to cloud for public connections items: type: string description: Custom prefixes to be advertised to cloud for public connections destinationEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' sourceEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' description: Interconnect cross connection custom peering information $$ref: '#/components/schemas/CustomPeeringInfo' peeringType: type: string description: Interconnect cross connection peering type vpnSegment: pattern: \d+ type: string description: Interconnect cross connection peering VPN segment description: Interconnect device connect peering information $$ref: '#/components/schemas/InterconnectCrossConnectionPeeringInfo' virtualNetworkAssociationType: type: string description: Interconnect cloud connect virtual network association type description: Interconnect cross connection cloud connection detail $$ref: '#/components/schemas/CloudConnectDetail' connectionId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect cross connection id connectionName: type: string description: Interconnect cross connection name connectionRole: type: string description: Interconnect cross connection role connectionSpeed: type: string description: Interconnect connectivity bandwidth connectionType: type: string description: Interconnect cross connection type deviceConnectDetail: required: - connectionDestination - connectionSource - peeringInfo type: object properties: connectionDestination: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' connectionSource: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' peeringInfo: required: - peeringType - vpnSegment type: object properties: customPeeringInfo: type: object properties: advertisedPrefixes: type: array description: Custom prefixes to be advertised to cloud for public connections items: type: string description: Custom prefixes to be advertised to cloud for public connections destinationEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' sourceEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' description: Interconnect cross connection custom peering information $$ref: '#/components/schemas/CustomPeeringInfo' peeringType: type: string description: Interconnect cross connection peering type vpnSegment: pattern: \d+ type: string description: Interconnect cross connection peering VPN segment description: Interconnect device connect peering information $$ref: '#/components/schemas/InterconnectCrossConnectionPeeringInfo' description: Interconnect cross connection device connection detail $$ref: '#/components/schemas/DeviceConnectDetail' interconnectAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect account id interconnectType: type: string description: Interconnect provider type licenseDetail: type: object properties: awsHcSkuEndDate: type: string awsHcSkuId: type: string endDate: type: string maxLicensedBandwidth: type: string skuId: type: string description: Interconnect cross connection license information $$ref: '#/components/schemas/InterconnectCrossConnectionLicenseDetail' licenseType: type: string description: Interconnect cross connection license type redundancyInfo: required: - connectionPairName type: object properties: connectionPairId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect cross connection pair id connectionPairName: type: string description: Interconnect cross connection pair name description: Interconnect cross connection redundancy information $$ref: '#/components/schemas/RedundancyInfo' resourceState: type: object properties: resourceAssociationDetails: type: array items: type: object properties: associatedResourceConnectionStatus: type: string associatedResourceId: type: string associatedResourceName: type: string associatedResourceStatus: type: string associatedResourceType: type: string $$ref: '#/components/schemas/ResourceAssociationDetail' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string description: Interconnect virtual network connection resource state information $$ref: '#/components/schemas/InterconnectResourceState' $$ref: '#/components/schemas/InterconnectCrossConnection' required: true responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/virtual-cross-connections/{connection-name}: get: tags: - Multicloud Interconnect - Connectivity summary: Retrieve an Interconnect virtual cross connection. description: API to retrieve an exisiting Interconnect virtual cross connection. operationId: getInterconnectCrossConnection parameters: - name: connection-name in: path description: Interconnect virtual cross connection name required: true schema: maxLength: 255 minLength: 1 type: string responses: '200': description: Accepted content: application/json: schema: type: object '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error put: tags: - Multicloud Interconnect - Connectivity summary: Update private Interconnect cross connection. description: API to update a virtual cross connection connection on an Interconnect Gateway at an Interconnect Provider. operationId: updateInterconnectCrossConnection parameters: - name: connection-name in: path description: Interconnect virtual cross connection name required: true schema: maxLength: 255 minLength: 1 type: string requestBody: description: Request Payload for Multicloud Interconnect Virtual Cross Connections content: application/json: schema: required: - connectionId - connectionName - connectionRole - connectionSpeed - connectionType - interconnectAccountId - interconnectType type: object properties: cloudConnectDetail: required: - cloudAccessType - cloudType - connectionDestination - connectionSource - peeringInfo type: object properties: awsCloudDetail: required: - cloudAccountId - cloudAccountName - crossConnectType type: object properties: cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect cloud connect AWS cloud account id cloudAccountName: type: string description: Interconnect cloud connect cloud account name cloudSideBgpAsn: pattern: \d+ type: string description: Interconnect cloud connect AWS cloud side BGP ASN crossConnectType: pattern: ^(HVIF|HCONN)$ type: string description: Interconnect cloud connect AWS cross connect type hostedConnectionId: type: string description: Interconnect cloud connect AWS hosted connection id virtualInterfaceId: type: string description: Interconnect cloud connect AWS hosted virtual interface id description: Interconnect cloud connect AWS cloud detail $$ref: '#/components/schemas/AwsCloudDetail' azureCloudDetail: required: - cloudAccountId - cloudAccountName - crossConnectType - serviceKey type: object properties: cloudAccountId: type: string description: Interconnect cloud connect Azure cloud account id cloudAccountName: type: string description: Interconnect cloud connect cloud account name crossConnectType: pattern: ^EXPRESS_ROUTE_CIRCUIT$ type: string description: Interconnect cloud connect Azure cross connect type serviceKey: maxLength: 255 minLength: 1 type: string description: Interconnect cloud connect Azure Express Route Circuit service key description: Interconnect cloud connect Azure cloud detail $$ref: '#/components/schemas/AzureCloudDetail' cloudAccessType: type: string description: Interconnect cloud connect cloud access type cloudType: type: string description: Interconnect cloud connect cloud provider type connectionDestination: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' connectionSource: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' googleCloudDetail: required: - cloudAccountName - crossConnectType - pairingKey type: object properties: cloudAccountId: type: string description: Google cloud account id cloudAccountName: type: string description: Interconnect cloud connect cloud account name crossConnectType: pattern: ^GCR_ATTACHMENT$ type: string description: Google cross connect type pairingKey: maxLength: 255 minLength: 1 type: string description: Google GCR attachment pairing key description: Interconnect cloud connect Google cloud detail $$ref: '#/components/schemas/GoogleCloudDetail' peeringInfo: required: - peeringType - vpnSegment type: object properties: customPeeringInfo: type: object properties: advertisedPrefixes: type: array description: Custom prefixes to be advertised to cloud for public connections items: type: string description: Custom prefixes to be advertised to cloud for public connections destinationEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' sourceEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' description: Interconnect cross connection custom peering information $$ref: '#/components/schemas/CustomPeeringInfo' peeringType: type: string description: Interconnect cross connection peering type vpnSegment: pattern: \d+ type: string description: Interconnect cross connection peering VPN segment description: Interconnect device connect peering information $$ref: '#/components/schemas/InterconnectCrossConnectionPeeringInfo' virtualNetworkAssociationType: type: string description: Interconnect cloud connect virtual network association type description: Interconnect cross connection cloud connection detail $$ref: '#/components/schemas/CloudConnectDetail' connectionId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect cross connection id connectionName: type: string description: Interconnect cross connection name connectionRole: type: string description: Interconnect cross connection role connectionSpeed: type: string description: Interconnect connectivity bandwidth connectionType: type: string description: Interconnect cross connection type deviceConnectDetail: required: - connectionDestination - connectionSource - peeringInfo type: object properties: connectionDestination: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' connectionSource: required: - resourceType type: object properties: gatewayDetail: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway id name: maxLength: 255 minLength: 1 type: string description: Interconnect gateway name ownerId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect gateway owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect gateway region id description: Interconnect connection end gateway detail $$ref: '#/components/schemas/GatewayDetail' interfaceDetail: type: object properties: bgpAsn: pattern: \d+ type: string description: BGP ASN of the connection end bgpKey: maxLength: 25 minLength: 1 type: string description: BGP key of the connection end interfaceName: maxLength: 64 minLength: 1 type: string description: Interface name of the connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Interface IP address of the connection end mtu: pattern: ^(1400|1496|1500)$ type: string description: MTU of the connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Interface IP address prefix of the connection end vlanId: pattern: \d+ type: string description: VLAN ID of the connection end description: Interconnect connection end interface detail $$ref: '#/components/schemas/InterconnectInterfaceDetail' portDetail: required: - id - name - ownerId - region - regionId type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect connection port id name: maxLength: 1024 minLength: 1 type: string description: Interconnect connection port name ownerId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port owner account id region: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region name regionId: maxLength: 255 minLength: 1 type: string description: Interconnect connection port region id description: Interconnect connection end port detail $$ref: '#/components/schemas/PortDetail' resourceType: type: string description: Interconnect connection end resource type description: Interconnect device connect connection destination $$ref: '#/components/schemas/ConnectionEndDetail' peeringInfo: required: - peeringType - vpnSegment type: object properties: customPeeringInfo: type: object properties: advertisedPrefixes: type: array description: Custom prefixes to be advertised to cloud for public connections items: type: string description: Custom prefixes to be advertised to cloud for public connections destinationEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' sourceEnd: type: object properties: bgpAsn: pattern: \d+ type: string description: Custom BGP ASN for a connection end ipAddress: pattern: ^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)((\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?)?$ type: string description: Custom ip address for a connection end prefix: pattern: ^(?:3[0-0]|[0-2]?[0-9])$ type: string description: Custom ip address prefix for a connection end description: Custom peering information for Interconnect cross connection destination $$ref: '#/components/schemas/CustomPeeringDetails' description: Interconnect cross connection custom peering information $$ref: '#/components/schemas/CustomPeeringInfo' peeringType: type: string description: Interconnect cross connection peering type vpnSegment: pattern: \d+ type: string description: Interconnect cross connection peering VPN segment description: Interconnect device connect peering information $$ref: '#/components/schemas/InterconnectCrossConnectionPeeringInfo' description: Interconnect cross connection device connection detail $$ref: '#/components/schemas/DeviceConnectDetail' interconnectAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect account id interconnectType: type: string description: Interconnect provider type licenseDetail: type: object properties: awsHcSkuEndDate: type: string awsHcSkuId: type: string endDate: type: string maxLicensedBandwidth: type: string skuId: type: string description: Interconnect cross connection license information $$ref: '#/components/schemas/InterconnectCrossConnectionLicenseDetail' licenseType: type: string description: Interconnect cross connection license type redundancyInfo: required: - connectionPairName type: object properties: connectionPairId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect cross connection pair id connectionPairName: type: string description: Interconnect cross connection pair name description: Interconnect cross connection redundancy information $$ref: '#/components/schemas/RedundancyInfo' resourceState: type: object properties: resourceAssociationDetails: type: array items: type: object properties: associatedResourceConnectionStatus: type: string associatedResourceId: type: string associatedResourceName: type: string associatedResourceStatus: type: string associatedResourceType: type: string $$ref: '#/components/schemas/ResourceAssociationDetail' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string description: Interconnect virtual network connection resource state information $$ref: '#/components/schemas/InterconnectResourceState' $$ref: '#/components/schemas/InterconnectCrossConnection' required: true responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error delete: tags: - Multicloud Interconnect - Connectivity summary: Delete an Interconnect virtual cross connection. description: API to delete an Interconnect virtual cross connection at an Interconnect provider. operationId: deleteInterconnectCrossConnection parameters: - name: connection-name in: path description: Interconnect virtual cross connection name required: true schema: maxLength: 255 minLength: 1 type: string responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/virtual-network-connections: get: tags: - Multicloud Interconnect - Connectivity summary: Retrieve all Interconnect virtual network connections. description: API to retrieve all exisiting Interconnect virtual network connections. operationId: getInterconnectVirtualNetworkConnections parameters: - name: connection-name in: query description: Interconnect virtual cross connection name schema: pattern: ^[\w.:-]{1,256}$ type: string - name: cloud-type in: query description: Cloud provider type schema: pattern: ^(AWS|AZURE|GCP)$ type: string - name: cloud-account-id in: query description: Cloud account id schema: maxLength: 255 minLength: 1 type: string - name: refresh in: query description: Interconnect virtual network connection provider sync enabled schema: pattern: (true|false) type: string default: 'false' responses: '200': description: Accepted content: application/json: schema: type: object '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Multicloud Interconnect - Connectivity summary: Create an Interconnect virtual network connection. description: API to create a Interconnect virtual network connection between virtual network Tags and OnRamp gateway connection. operationId: createInterconenctVirtualNetworkConnection requestBody: description: Request Payload for Interconnect virtual network Connections content: application/json: schema: type: array items: required: - cloudAccountId - cloudAccountName - cloudType - connectionName - virtualNetworkTagAssociationType - virtualNetworkTagAssociations - virtualNetworkTags type: object properties: cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect virtual network connection cloud account id cloudAccountName: type: string description: Interconnect virtual network connection cloud account name cloudType: pattern: ^(AWS|AZURE)$ type: string description: Cloud provider type connectionId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect virtual network connection id connectionName: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect virtual network connection name resourceState: type: object properties: resourceAssociationDetails: type: array items: type: object properties: associatedResourceConnectionStatus: type: string associatedResourceId: type: string associatedResourceName: type: string associatedResourceStatus: type: string associatedResourceType: type: string $$ref: '#/components/schemas/ResourceAssociationDetail' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string description: Interconnect virtual network connection resource state information $$ref: '#/components/schemas/InterconnectResourceState' virtualNetworkTagAssociationType: type: string description: 'Interconnect virtual network connection tag association type ' virtualNetworkTagAssociations: type: array description: Interconnect virtual network connection virtual network tag association list items: required: - resourceType type: object properties: onRampGatewayConnection: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect onRamp gateway connection id name: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect onRamp gateway connection name description: Interconnect onRamp gateway connection information $$ref: '#/components/schemas/OnRampGatewayConnection' resourceType: type: string description: Type of resource to be associated to the tag description: Interconnect virtual network connection virtual network tag association list $$ref: '#/components/schemas/VirtualNetworkTagAssociation' virtualNetworkTags: type: array description: Interconnect virtual network connection virtual network tag list items: required: - tagName type: object properties: tagName: maxLength: 255 minLength: 1 type: string description: Name of the Host VPC/VNET tag description: Interconnect virtual network connection virtual network tag list $$ref: '#/components/schemas/VirtualNetworkTag' $$ref: '#/components/schemas/InterconnectVirtualNetworkConnection' required: true responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/connectivity/virtual-network-connections/{connection-name}: get: tags: - Multicloud Interconnect - Connectivity summary: Retrieve an Interconnect virtual network connection. description: API to retrieve an exisiting Interconnect Interconnect virtual network connection. operationId: getInterconnectVirtualNetworkConnection parameters: - name: connection-name in: path description: Interconnect virtual network connection name required: true schema: pattern: ^[\w.:-]{1,256}$ type: string responses: '200': description: Accepted content: application/json: schema: required: - cloudAccountId - cloudAccountName - cloudType - connectionName - virtualNetworkTagAssociationType - virtualNetworkTagAssociations - virtualNetworkTags type: object properties: cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect virtual network connection cloud account id cloudAccountName: type: string description: Interconnect virtual network connection cloud account name cloudType: pattern: ^(AWS|AZURE)$ type: string description: Cloud provider type connectionId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect virtual network connection id connectionName: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect virtual network connection name resourceState: type: object properties: resourceAssociationDetails: type: array items: type: object properties: associatedResourceConnectionStatus: type: string associatedResourceId: type: string associatedResourceName: type: string associatedResourceStatus: type: string associatedResourceType: type: string $$ref: '#/components/schemas/ResourceAssociationDetail' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string description: Interconnect virtual network connection resource state information $$ref: '#/components/schemas/InterconnectResourceState' virtualNetworkTagAssociationType: type: string description: 'Interconnect virtual network connection tag association type ' virtualNetworkTagAssociations: type: array description: Interconnect virtual network connection virtual network tag association list items: required: - resourceType type: object properties: onRampGatewayConnection: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect onRamp gateway connection id name: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect onRamp gateway connection name description: Interconnect onRamp gateway connection information $$ref: '#/components/schemas/OnRampGatewayConnection' resourceType: type: string description: Type of resource to be associated to the tag description: Interconnect virtual network connection virtual network tag association list $$ref: '#/components/schemas/VirtualNetworkTagAssociation' virtualNetworkTags: type: array description: Interconnect virtual network connection virtual network tag list items: required: - tagName type: object properties: tagName: maxLength: 255 minLength: 1 type: string description: Name of the Host VPC/VNET tag description: Interconnect virtual network connection virtual network tag list $$ref: '#/components/schemas/VirtualNetworkTag' $$ref: '#/components/schemas/InterconnectVirtualNetworkConnection' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error delete: tags: - Multicloud Interconnect - Connectivity summary: Delete an Interconnect virtual network connection. description: API to delete an Interconnect virtual network connection. operationId: deleteInterconnectVirtualNetworkConnection parameters: - name: connection-name in: path description: Interconnect virtual cross connection name required: true schema: pattern: ^[\w.:-]{1,256}$ type: string responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error put: tags: - Multicloud Interconnect - Connectivity summary: Update a private Interconnect virtual network connection. description: API to update a virtual network connection between virtual network Tags and onRamp gateway connection. operationId: updateInterconnectVirtualNetworkConnection parameters: - name: connection-name in: path description: Interconnect virtual network connection name required: true schema: pattern: ^[\w.:-]{1,256}$ type: string requestBody: description: Request Payload for Interconnect virtual network connections content: application/json: schema: required: - cloudAccountId - cloudAccountName - cloudType - connectionName - virtualNetworkTagAssociationType - virtualNetworkTagAssociations - virtualNetworkTags type: object properties: cloudAccountId: maxLength: 255 minLength: 1 type: string description: Interconnect virtual network connection cloud account id cloudAccountName: type: string description: Interconnect virtual network connection cloud account name cloudType: pattern: ^(AWS|AZURE)$ type: string description: Cloud provider type connectionId: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect virtual network connection id connectionName: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect virtual network connection name resourceState: type: object properties: resourceAssociationDetails: type: array items: type: object properties: associatedResourceConnectionStatus: type: string associatedResourceId: type: string associatedResourceName: type: string associatedResourceStatus: type: string associatedResourceType: type: string $$ref: '#/components/schemas/ResourceAssociationDetail' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string description: Interconnect virtual network connection resource state information $$ref: '#/components/schemas/InterconnectResourceState' virtualNetworkTagAssociationType: type: string description: 'Interconnect virtual network connection tag association type ' virtualNetworkTagAssociations: type: array description: Interconnect virtual network connection virtual network tag association list items: required: - resourceType type: object properties: onRampGatewayConnection: required: - name type: object properties: id: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Interconnect onRamp gateway connection id name: pattern: ^[\w.:-]{1,256}$ type: string description: Interconnect onRamp gateway connection name description: Interconnect onRamp gateway connection information $$ref: '#/components/schemas/OnRampGatewayConnection' resourceType: type: string description: Type of resource to be associated to the tag description: Interconnect virtual network connection virtual network tag association list $$ref: '#/components/schemas/VirtualNetworkTagAssociation' virtualNetworkTags: type: array description: Interconnect virtual network connection virtual network tag list items: required: - tagName type: object properties: tagName: maxLength: 255 minLength: 1 type: string description: Name of the Host VPC/VNET tag description: Interconnect virtual network connection virtual network tag list $$ref: '#/components/schemas/VirtualNetworkTag' $$ref: '#/components/schemas/InterconnectVirtualNetworkConnection' required: true responses: '200': description: Interconnect Process ID Information. content: application/json: schema: type: object properties: id: type: string description: Procees Id of the task example: 51d0a0e4-983a-471c-9abb-724d58144884 $$ref: '#/components/schemas/ProcessResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error ? /multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/cloud/{cloud-type}/connectivity/connections/partner-ports : get: tags: - Multicloud Interconnect - Connectivity summary: Get Interconnect provider partner regions. description: API to retrieve supported partner regions for an Interconnect provider. operationId: getInterconnectPartnerPorts parameters: - name: interconnect-type in: path description: Interconnect provider Type required: true schema: type: string - name: interconnect-account-id in: path description: Interconnect provider account id required: true schema: maxLength: 255 minLength: 1 type: string - name: cloud-type in: path description: Cloud provider type required: true schema: type: string - name: connect-type in: query description: Interconnect connection connect type schema: type: string - name: vxc-permitted in: query description: Interconnect connection cross connect enabled schema: pattern: (true|false) type: string - name: authorization-key in: query description: Cloud connectivity gateway service/pairing key schema: maxLength: 255 minLength: 1 type: string - name: refresh in: query description: Interconnect connection provider sync enabled schema: pattern: (true|false) type: string default: 'false' responses: '200': description: Accepted content: application/json: schema: type: object properties: edgePartnerPortsList: type: array items: type: object properties: attPartnerPort: type: object properties: authorizationKey: type: string companyUid: type: string description: Megaport companyId for the region. example: 2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc connectType: type: string enum: - AWS - AWSHC - PRIMARY - SECONDARY - INTERCONNECT_ATTACHMENT productUid: type: string description: Megaport id for the region. example: 2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc speed: type: string description: Bandwidth speeds supported at the region. vxcId: type: string description: Cross connect (VXC) id connected to the region example: None vxcPermitted: type: boolean description: Cross Connect enabled Megaport region. example: true description: Megaport specific partner port fields. $$ref: '#/components/schemas/InterconnectPartnerPortsDetails' cloudType: type: string enum: - AWS - AWS_GOVCLOUD - AZURE - AZURE_GOVCLOUD - GCP edgeType: type: string enum: - MEGAPORT - EQUINIX eqPartnerPort: type: object properties: authorizationKey: type: string companyUid: type: string description: Megaport companyId for the region. example: 2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc connectType: type: string enum: - AWS - AWSHC - PRIMARY - SECONDARY - INTERCONNECT_ATTACHMENT productUid: type: string description: Megaport id for the region. example: 2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc speed: type: string description: Bandwidth speeds supported at the region. vxcId: type: string description: Cross connect (VXC) id connected to the region example: None vxcPermitted: type: boolean description: Cross Connect enabled Megaport region. example: true description: Megaport specific partner port fields. $$ref: '#/components/schemas/InterconnectPartnerPortsDetails' locationId: type: string mpPartnerPort: type: object properties: authorizationKey: type: string companyUid: type: string description: Megaport companyId for the region. example: 2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc connectType: type: string enum: - AWS - AWSHC - PRIMARY - SECONDARY - INTERCONNECT_ATTACHMENT productUid: type: string description: Megaport id for the region. example: 2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc speed: type: string description: Bandwidth speeds supported at the region. vxcId: type: string description: Cross connect (VXC) id connected to the region example: None vxcPermitted: type: boolean description: Cross Connect enabled Megaport region. example: true description: Megaport specific partner port fields. $$ref: '#/components/schemas/InterconnectPartnerPortsDetails' name: type: string description: Interconnect partner port information $$ref: '#/components/schemas/InterconnectPartnerPorts' $$ref: '#/components/schemas/InlineResponse2006' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error ? /multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/connectivity/connections/{connection-type}/port-speeds : get: tags: - Multicloud Interconnect - Connectivity summary: Get Interconnect port speeds. description: API to retrieve supported port speeds for an Interconnect connectivity. operationId: getInterconnectPortSpeeds parameters: - name: interconnect-type in: path description: Interconnect provider Type required: true schema: type: string - name: interconnect-account-id in: path description: Interconnect provider account id required: true schema: maxLength: 255 minLength: 1 type: string - name: connection-type in: path description: Interconnect connectivity type required: true schema: pattern: (cloud|edge|saas|deviceLink|CLOUD_CONNECT|DEVICE_CONNECT) type: string - name: cloud-type in: query description: Cloud provider type schema: type: string - name: cloud-account-id in: query description: Cloud account id schema: maxLength: 255 minLength: 1 type: string - name: connect-type in: query description: Interconnect connection connect type schema: type: string - name: connect-subtype in: query description: Interconnect connection connect sub-type schema: type: string - name: connectivity-gateway-name in: query description: Cloud connectivity gateway name schema: maxLength: 255 minLength: 1 type: string - name: partner-port in: query description: Interconnect cloud onRamp partner port location name schema: maxLength: 1024 minLength: 1 type: string - name: authorization-key in: query description: Cloud connectivity gateway service/pairing key schema: maxLength: 255 minLength: 1 type: string responses: '200': description: Accepted content: application/json: schema: type: object properties: portSpeeds: type: array description: port speed list example: - '50' - '100' - '200' - '500' - '1000' - '5000' items: type: string description: port speed example: '50' $$ref: '#/components/schemas/InlineResponse2007' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/{interconnect-type}/connectivity/device-links/metro-speed: post: tags: - Multicloud Interconnect - Connectivity summary: Get Device-Link metro speed. description: API to get metro speed for Device-Link by Device-Link Configuration. operationId: getInterconnectDeviceLinkMetroSpeed parameters: - name: interconnect-type in: path description: Interconnect Provider Type required: true schema: type: string enum: - MEGAPORT - EQUINIX requestBody: description: Request Payload for Multicloud Interconnect Device Links content: application/json: schema: required: - bandwidth - deviceLinkName - edgeAccountId - edgeType type: object properties: bandwidth: type: string description: Device-Link Bandwidth Input. example: '50' deviceLinkName: maxLength: 50 minLength: 3 pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Device-Link. example: my-device-link deviceLinkUuid: pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' type: string description: Uuid of the Interconnect Device-Link example: 496bddbd-e104-44a7-ba62-7a285f642304 deviceLinksubnet: type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 deviceList: maxItems: 2147483647 minItems: 2 type: array items: type: object properties: deviceInterfaceId: type: string description: Interface used on the Interconnect Gateway to connect to the Device-Link. example: GigabitEthernet4 deviceIntfIpAddress: type: string description: IP assigned to the Interconnect Gateway interface to connect to the Device-Link. example: 20.10.0.2 deviceName: pattern: ^[\w.-]{3,50}$ type: string description: Name of the Interconnect Gateway in the Device-Link. example: ICGW_1 deviceUuid: type: string description: Uuid of Interconnect Gateway in the Device-Link. example: 0dc43131-47c9-4fce-8499-f02e3340c9fb egwLoopBackCidr: type: string description: IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel. example: 172.31.251.8/30 $$ref: '#/components/schemas/InterconnectDeviceLinkDeviceList' dlMetroBandwidth: type: string description: Device-Link Bandwidth at a given Metro. example: '150' edgeAccountId: maxLength: 255 minLength: 1 type: string edgeAccountName: maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9_\-\s]+$ type: string edgeType: type: string linkBandwidth: type: string description: Device-Link Bandwidth. example: '50' resourceState: type: string resourceStateMessage: type: string resourceStateUpdateTs: type: string subnet: pattern: ^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\/(?:3[0-2]|[0-2]?[0-9])$ type: string description: Subnet pool for Interconnect Gateway interfaces in the Device-Link. example: 20.10.0.0/16 version: type: string description: Version of the payload. example: '1' description: Interconnect Device-Link Object $$ref: '#/components/schemas/InterconnectDeviceLink' examples: Interconnect Equinix Device Link: description: Interconnect Equinix Device Link value: edgeType: EQUINIX edgeAccountId: ABCD-1234-CDEF edgeAccountName: interconnect-account-name deviceLinkName: my-device-link subnet: 20.10.0.0/16 bandwidth: '100' deviceList: - deviceName: ICGW_1 - deviceName: ICGW_2 required: true responses: '200': description: Accepted content: application/json: schema: type: object properties: dlMetroBandwidth: type: integer description: Device-Link metro speed format: int64 example: 200 $$ref: '#/components/schemas/InlineResponse20012' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /multicloud/interconnect/{interconnect-type}/connectivity/device-links/port-speeds: get: tags: - Multicloud Interconnect - Connectivity summary: Get Device-Link port speeds. description: API to get supported port speeds for Device-Link by Interconnect provider. operationId: getInterconnectDeviceLinkPortSpeeds parameters: - name: interconnect-type in: path description: Interconnect Provider Type required: true schema: type: string responses: '200': description: Accepted content: application/json: schema: type: object properties: portSpeeds: type: array description: Supported port speeds example: - 50, 100 items: type: string description: speed example: '50' $$ref: '#/components/schemas/InlineResponse20011' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error