{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/36693899-8b64-31bd-aa1c-b67fb5b6463c","info":{"title":"SD-WAN Services","description":"Includes API operations for managing SD-WAN services such as Cloud OnRamp for SaaS and MultiCloud\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"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","title":"CloudConnectDetail"}}