Edit Interconnect Gateway Information - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Edit Interconnect Gateway Information","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":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Edit Interconnect Gateway Information.","description":"API to update the Interconnect Gateway Information in vManage.","operationId":"updateInterconnectGateway_MulticloudInterconnectGateways_6103","parameters":[{"name":"interconnect-gateway-name","in":"path","description":"Interconnect gateway name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Gateways","content":{"application/json":{"schema":{"required":["deviceUuid","edgeAccountId","edgeBillingAccountId","edgeGatewayName","edgeType","ipTransit","licenseType","region","regionId","siteName"],"type":"object","properties":{"configGroupSettings":{"required":["configGroupId","configGroupName"],"type":"object","properties":{"configGroupId":{"maxLength":255,"minLength":1,"type":"string","description":"Config Group Id","example":"482eb6f3-1168-4b6f-901a-bd2c788b370d"},"configGroupName":{"maxLength":255,"minLength":1,"type":"string","description":"Config Group name","example":"My-CG-1"}},"$$ref":"#/components/schemas/InterconnectConfigGroupSettings"},"description":{"maxLength":255,"minLength":1,"type":"string"},"deviceUuid":{"maxLength":255,"minLength":1,"type":"string"},"edgeAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeBillingAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeGatewayName":{"maxLength":255,"minLength":1,"type":"string"},"edgeType":{"type":"string"},"egwBgpAsn":{"type":"string","description":"BGP ASN assigned to Interconnect Gateway","example":"64500"},"ipTransit":{"maxLength":255,"minLength":1,"type":"string"},"ipTransitId":{"type":"string"},"ipTransitSkuId":{"type":"string"},"isCustomSetting":{"type":"boolean","description":"Custom Settings enabled for Interconnect Gateway","example":true},"licenseSkuId":{"type":"string","description":"License Sku Id of Interconnect Gateway","example":"12345"},"licenseType":{"type":"string","enum":["PAYG","PREPAID","DIRECT"]},"loopbackCidr":{"type":"string","description":"Ip pool allocated to Interconnect Gateway for Loopback Interfaces","example":"172.31.251.4/30"},"mrfSettings":{"type":"object","properties":{"mrfRouterRole":{"type":"string","description":"Multi Region Fabric router role","example":"border"},"mrfTransportGateway":{"type":"boolean","description":"Multi Region Fabric Transport Gateway","example":false},"nhmRegionId":{"type":"integer","description":"Network Hierarchy Region Id","format":"int64","example":123},"nhmRegionName":{"type":"string","description":"Network Hierarchy Region name","example":"My-Region"}},"$$ref":"#/components/schemas/InterconnectMrfSettings"},"region":{"maxLength":255,"minLength":1,"type":"string"},"regionId":{"maxLength":255,"minLength":1,"type":"string"},"resourceState":{"type":"string"},"resourceStateMessage":{"type":"string"},"resourceStateUpdateTs":{"type":"string"},"serviceChainAttachments":{"type":"string"},"settings":{"required":["instanceSize","softwareImageId"],"type":"object","properties":{"edgeGatewaySolution":{"type":"string","enum":["MVE","NE"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX","ATT"]},"egwCustomSettingName":{"type":"string","description":"Assigned name of the Interconnect Gateway Custom Settings"},"instanceSize":{"maxLength":255,"minLength":1,"type":"string"},"ipSubnetPool":{"type":"string","description":"Ip subnet pool assigned to the gateway","example":"192.168.10.0/24"},"softwareImageId":{"maxLength":255,"minLength":1,"pattern":"^C8000v.*$","type":"string"}},"$$ref":"#/components/schemas/InterconnectGatewaySettings"},"siteName":{"maxLength":255,"minLength":1,"type":"string"}},"$$ref":"#/components/schemas/InterconnectGatewayExtended"},"examples":{"Interconnect Megaport Gateways":{"description":"Interconnect Megaport Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"mp-gateway-name","description":"This is my Megaport gateway","region":"Cologix TOR1, Toronto, ON, Canada : Toronto","regionId":"10","siteName":"My_Megaport_Site","deviceUuid":"C8K-f7f6c42c-409d-11eb-9562-005056841be8","settings":{"instanceSize":"Small","softwareImageId":"C8000v 17.09.01a"},"mrfSettings":{"mrfRouterRole":"border","mrfTransportGateway":false}}},"Interconnect Equinix Gateways - MRF Enabled":{"description":"Interconnect Equinix Gateways - MRF Enabled","value":"{\n \"edgeType\": \"EQUINIX\",\n \"edgeAccountId\": \"ABCD-1234-CDEF\",\n \"edgeGatewayName\": \"eq-gateway-name\",\n \"description\": \"This is my Equinix Gateway\",\n \"region\": \"NY Metro\",\n \"regionId\": \"10\",\n \"edgeBillingAccountId\": \"ABCD-1234-CDEF\",\n \"siteName\": \"My_Equinix_Site\",\n \"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n \"mrfSettings\": {\n \"mrfRouterRole\": \"edge\",\n \"mrfTransportGateway\": false\n }\n \"settings\": {\n \"instanceSize\": \"Small\",\n \"softwareImageId\": \"CSR1000v 17.03.03\"\n }\n}"}}}},"required":true},"responses":{"200":{"description":"Interconnect Gateway Information.","content":{"application/json":{"schema":{"required":["deviceUuid","edgeAccountId","edgeBillingAccountId","edgeGatewayName","edgeType","ipTransit","licenseType","region","regionId","siteName"],"type":"object","properties":{"configGroupSettings":{"required":["configGroupId","configGroupName"],"type":"object","properties":{"configGroupId":{"maxLength":255,"minLength":1,"type":"string","description":"Config Group Id","example":"482eb6f3-1168-4b6f-901a-bd2c788b370d"},"configGroupName":{"maxLength":255,"minLength":1,"type":"string","description":"Config Group name","example":"My-CG-1"}},"$$ref":"#/components/schemas/InterconnectConfigGroupSettings"},"description":{"maxLength":255,"minLength":1,"type":"string"},"deviceUuid":{"maxLength":255,"minLength":1,"type":"string"},"edgeAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeBillingAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeGatewayName":{"maxLength":255,"minLength":1,"type":"string"},"edgeType":{"type":"string"},"egwBgpAsn":{"type":"string","description":"BGP ASN assigned to Interconnect Gateway","example":"64500"},"ipTransit":{"maxLength":255,"minLength":1,"type":"string"},"ipTransitId":{"type":"string"},"ipTransitSkuId":{"type":"string"},"isCustomSetting":{"type":"boolean","description":"Custom Settings enabled for Interconnect Gateway","example":true},"licenseSkuId":{"type":"string","description":"License Sku Id of Interconnect Gateway","example":"12345"},"licenseType":{"type":"string","enum":["PAYG","PREPAID","DIRECT"]},"loopbackCidr":{"type":"string","description":"Ip pool allocated to Interconnect Gateway for Loopback Interfaces","example":"172.31.251.4/30"},"mrfSettings":{"type":"object","properties":{"mrfRouterRole":{"type":"string","description":"Multi Region Fabric router role","example":"border"},"mrfTransportGateway":{"type":"boolean","description":"Multi Region Fabric Transport Gateway","example":false},"nhmRegionId":{"type":"integer","description":"Network Hierarchy Region Id","format":"int64","example":123},"nhmRegionName":{"type":"string","description":"Network Hierarchy Region name","example":"My-Region"}},"$$ref":"#/components/schemas/InterconnectMrfSettings"},"region":{"maxLength":255,"minLength":1,"type":"string"},"regionId":{"maxLength":255,"minLength":1,"type":"string"},"resourceState":{"type":"string"},"resourceStateMessage":{"type":"string"},"resourceStateUpdateTs":{"type":"string"},"serviceChainAttachments":{"type":"string"},"settings":{"required":["instanceSize","softwareImageId"],"type":"object","properties":{"edgeGatewaySolution":{"type":"string","enum":["MVE","NE"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX","ATT"]},"egwCustomSettingName":{"type":"string","description":"Assigned name of the Interconnect Gateway Custom Settings"},"instanceSize":{"maxLength":255,"minLength":1,"type":"string"},"ipSubnetPool":{"type":"string","description":"Ip subnet pool assigned to the gateway","example":"192.168.10.0/24"},"softwareImageId":{"maxLength":255,"minLength":1,"pattern":"^C8000v.*$","type":"string"}},"$$ref":"#/components/schemas/InterconnectGatewaySettings"},"siteName":{"maxLength":255,"minLength":1,"type":"string"}},"$$ref":"#/components/schemas/InterconnectGatewayExtended"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"put","path":"/multicloud/interconnect/gateways/{interconnect-gateway-name}"}}