Get OnRamp gateway connection by name - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get OnRamp gateway connection by name","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 - 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":{"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"}},"method":"get","path":"/multicloud/interconnect/connectivity/cloud-onramp-gateway-connections/{connection-name}"}}