{"type":"api","title":"Get Cgw Details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateway by name","operationId":"getCgwDetails","parameters":[{"name":"cloudGatewayName","in":"path","description":"Multicloud cloud gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"cloudGatewayId":{"type":"string"},"cloudGatewayMode":{"type":"string","description":"Only applicable to AWS/AWS_GOVCLOUD CloudTypes"},"cloudGatewayName":{"type":"string"},"cloudGatewaySolution":{"type":"string"},"cloudProviderASN":{"type":"integer","description":"CGW details relevant to AWS/AWS_GOVCLOUD","format":"int32"},"cloudProviderMgmtReference":{"type":"string","description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"cloudType":{"type":"string"},"connectedSites":{"type":"integer","format":"int32"},"connectivityState":{"type":"string"},"connectivityStateUpdateTs":{"type":"number"},"customSettings":{"type":"boolean"},"description":{"type":"string"},"devices":{"type":"array","items":{"type":"string"}},"mrfRouterRole":{"type":"string"},"region":{"type":"string"},"resourceGroupName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"routeTableCount":{"type":"string","description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"s2sPermitted":{"type":"boolean","description":"Only applicable to GCP CloudGateways"},"settings":{"type":"object","properties":{"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]*$","type":"string"},"cloudType":{"pattern":"^[a-zA-Z_]*$","type":"string"},"instanceSize":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string"},"ipSubnetPool":{"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]))(?:\\s*,\\s*(?: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"},"name":{"pattern":"^[a-zA-Z_]*$","type":"string"},"networkTier":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string","description":"Used for GCP Custom settings"},"skuScaleUnit":{"pattern":"^[0-9]*$","type":"string","description":"Used for Azure/Azure GovCloud Custom settings"},"softwareImageId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"tunnelCount":{"pattern":"^[0-9]*$","type":"string","description":"Tunnel Count for AWS Connect based and branch connect"}},"$$ref":"#/components/schemas/CustomSettings"},"siteName":{"type":"string"},"status":{"type":"string"},"tunnelCidrBlocks":{"type":"array","description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"type":"object","description":"CGW details relevant to AWS/AWS_GOVCLOUD"}},"tunnels":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"type":"object","properties":{"acceptedRouteCount":{"type":"integer","format":"int32"},"lastStatusChangeTimestamp":{"type":"string"},"outerIpAddr":{"type":"string"},"status":{"type":"string"},"statusMessage":{"type":"string"},"tunnelId":{"type":"string"},"tunnelInnerIp":{"type":"array","items":{"type":"string"}}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","$$ref":"#/components/schemas/TunnelsInner"}},"vhubName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"virtualRouterAsn":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"vpns":{"type":"array","items":{"type":"string"}},"vwanName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"}},"$$ref":"#/components/schemas/CloudGatewayAdjusted"},"examples":{"Get GCP CGW ":{"description":"Get GCP CGW ","value":{"cloudGatewayName":"gcp-test","accountName":"gcp-dev","devices":["C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1","C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B","C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"description":"","cloudProviderMgmtReference":"NA","connectivityStateUpdateTs":1654905819730,"s2sPermitted":true,"accountId":"gcp-project-nprd-31900","cloudProviderAsn":0,"sshKeyName":"","tunnelCidrBlocks":[],"cloudGatewayId":"s2c-hub-gcp-test, s2s-hub-gcp-test","cloudType":"GCP","customSettings":true,"cloudGatewaySolution":"gcp","region":"us-west4","connectivityState":"Successful","routeTableCount":"NA","settings":{"softwareImageId":"cisco-c8k-17-05-01a-cisco-public","instanceSize":"n1-standard-4","ipSubnetPool":"10.0.0.0/16","networkTier":"STANDARD"},"status":"error","vpns":[{"vpnId":"9"}],"connectedSites":0,"tunnels":[{"tunnelId":"C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}]}},"Get AWS/AWS GovCloud CGW ":{"description":"Get AWS/AWS GovCloud CGW ","value":{"cloudGatewayName":"aws-test","accountName":"aws-dev","devices":["C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C","C8K-C516558F-45CA-3486-38FD-5D0306E05999"],"description":"","cloudProviderMgmtReference":"","connectivityStateUpdateTs":1655144961158,"accountId":"759589527992","cloudProviderAsn":64520,"tunnelCidrBlocks":[],"cloudGatewayId":"tgw-0b6ac1173825c3663","cloudType":"AWS","customSettings":true,"cloudGatewaySolution":"tgw_tvpc","region":"us-east-1","connectivityState":"Successful","routeTableCount":"2","settings":{"softwareImageId":"Cisco-C8K-17.04.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1-ami-012fee29ab1f5f2c3.4","instanceSize":"c5.large","ipSubnetPool":"11.0.0.0/16"},"status":"normal","vpns":[{"vpnId":"9"}],"connectedSites":2,"tunnels":[{"tunnelId":"C8K-C516558F-45CA-3486-38FD-5D0306E05999::9","tunnelInnerIps":["169.254.0.12/30","169.254.0.16/30"],"status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C::9","tunnelInnerIps":["169.254.0.4/30","169.254.0.8/30"],"status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}]}},"Get Azure/Azure GovCloud CGW":{"description":"Get Azure/Azure GovCloud CGW","value":{"resourceGroupName":"azure-rgp","cloudGatewayName":"az-test","accountName":"ramL","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"virtualRouterAsn":"65515","vhubName":"az-test","description":"","vwanName":"azure-vwan","connectivityStateUpdateTs":1655141135729,"accountId":"8b188c39-f358-4db6-a44f-84068541233a","cloudGatewayId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","cloudType":"AZURE","customSettings":false,"region":"westus2","connectivityState":"initialized","cloudGatewaySolution":"vhub","settings":{"softwareImageId":"17.6.01","skuScaleUnit":2,"ipSubnetPool":"10.0.0.0/16","instanceSize":2},"status":"normal","vpns":[],"connectedSites":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/multicloud/cloudgateway/{cloudGatewayName}"}}