Get all Interconnect Gateways - Cisco Catalyst SD-WAN Manager API, Release 20.16

{"type":"api","title":"Get all Interconnect Gateways","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","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":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get all Interconnect Gateways.","description":"API to retrieve all Interconnect Gateways from vManage.","operationId":"getInterconnectGateways","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"query","description":"Interconnect provider account id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Interconnect Region","schema":{"type":"string"}},{"name":"region-id","in":"query","description":"Interconnect Region Id","schema":{"type":"string"}},{"name":"interconnect-gateway-name","in":"query","description":"Interconnect Gateway Name","schema":{"type":"string"}},{"name":"resource-state","in":"query","description":"Interconnect Resource State","schema":{"type":"string"}},{"name":"interconnect-billing-account-id","in":"query","description":"Interconnect Billing Account Id","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"All Interconnect Gateways .","content":{"application/json":{"schema":{"type":"array","items":{"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"}},"__originalOperationId":"getInterconnectGateways","method":"get","path":"/multicloud/interconnect/gateways"}}