Create Cgw - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Create Cgw","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":"Create cloud gateway","operationId":"createCgw","requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"required":["accountId","azureProperties","cloudGatewayName","cloudType"],"type":"object","properties":{"accountId":{"type":"string"},"awsCwanProperties":{"type":"object","properties":{"coreNetworkEdgeId":{"type":"string","description":"Refers to AWS site id within the core network"},"coreNetworkEdgeSource":{"type":"string","enum":["aws","tvpcOnly","toBeCreated"]},"coreNetworkId":{"type":"string"},"coreNetworkSource":{"type":"string","enum":["aws","tvpcOnly","toBeCreated"]}},"description":"Used in AWS/AWS Govcloud CGW creation. Null if type is TGW based","$$ref":"#/components/schemas/CloudGatewayPostAwsCwanProperties"},"awsTgwProperties":{"type":"object","properties":{"tgwConnections":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Defines a list of TGW connections. Null if tgwSource is not aws","items":{"type":"object","properties":{"tgwRouteTableId":{"type":"string"},"vpnId":{"type":"string"}},"description":"Defines a list of TGW connections. Null if tgwSource is not aws","$$ref":"#/components/schemas/TgwConnectionsInner"}},"tgwId":{"type":"string"},"tgwSource":{"type":"string","enum":["aws","tvpcOnly","toBeCreated"]}},"description":"Used in AWS/AWS Govcloud CGW creation. Null if type is cloudwan based","$$ref":"#/components/schemas/CloudGatewayPostAwsTgwProperties"},"azureProperties":{"required":["resourceGroupName","resourceGroupSource","vhubName","vhubSource","vwanName","vwanSource"],"type":"object","properties":{"nvaSource":{"type":"string"},"resourceGroupName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"},"resourceGroupSource":{"type":"string"},"vhubName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"},"vhubSource":{"type":"string"},"vpnGatewaySource":{"type":"string"},"vwanName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"},"vwanSource":{"type":"string"}},"description":"Used in Azure/Azure GovCloud CGW creation","$$ref":"#/components/schemas/CloudGatewayPostAzureProperties"},"cloudGatewayMode":{"pattern":"^(sdwan|sd-routing)$","type":"string"},"cloudGatewayName":{"maxLength":255,"minLength":1,"type":"string"},"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]+$","type":"string"},"cloudGatewayTag":{"pattern":"^[a-zA-Z0-9_./\\\\\\-]+$","type":"string"},"cloudType":{"type":"string"},"configGroupSettings":{"type":"object","properties":{"configGroupId":{"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"},"configGroupName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"}},"description":"Used in Azure/Azure GovCloud CGW creation","$$ref":"#/components/schemas/CloudGatewayPostConfigGroupSettings"},"description":{"maxLength":1024,"minLength":0,"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"devices":{"type":"array","items":{"type":"string"}},"mrfRouterRole":{"pattern":"^(edge|border)$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"s2sPermitted":{"pattern":"^(true|false)$","type":"string"},"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/AllOfcloudGatewayPostSettings"},"siteName":{"pattern":"^[a-zA-Z0-9_./\\\\\\-]+$","type":"string"},"sshKeyName":{"pattern":"^[a-zA-Z0-9_./\\\\\\-]+$","type":"string"}},"$$ref":"#/components/schemas/CloudGatewayPost"},"examples":{"GCP CGW Create request":{"description":"GCP CGW Create request","value":{"accountId":"gcp-project-nprd-312512","cloudType":"GCP","region":"us-west4","cloudGatewayName":"gcp-test","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"GCP post request","s2sPermitted":false,"mrfRouterRole":"border","siteName":"SITE_1","configGroupSettings":{"configGroupName":"CG_1","configGroupId":"d0846e2c-a977-46fa-8acb-0e387a30eadf"}}},"AWS/AWS GovCloud CGW create request":{"description":"AWS/AWS GovCloud CGW create request","value":{"accountId":"238112874124","cloudType":"AWS","region":"us-east-1","cloudGatewayName":"aws-test","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"AWS/AWS_GOVCLOUD post request","mrfRouterRole":"border","siteName":"SITE_1","configGroupSettings":{"configGroupName":"CG_1","configGroupId":"d0846e2c-a977-46fa-8acb-0e387a30eadf"}}},"Azure/Azure GovCloud CGW create request":{"description":"Azure/Azure GovCloud CGW create request","value":{"accountId":"81k99acb9-1a58-b3b6-214f-840623g789a0","cloudType":"AZURE","region":"westus2","cloudGatewayName":"azure-test","mrfRouterRole":"border","siteName":"SITE_1","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299 C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"AZURE/AZURE_GOVCLOUD post request","azureProperties":{"resourceGroupName":"azureTestRGP","resourceGroupSource":"azure","vwanName":"azureTestVwan","vwanSource":"azure","vhubName":"azureTestVhub","vhubSource":"toBeCreated","nvaSource":"toBeCreated"},"configGroupSettings":{"configGroupName":"CG_1","configGroupId":"d0846e2c-a977-46fa-8acb-0e387a30eadf"}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"6c723f65-9106-4f43-9d2b-a033a39353b3"}},"description":"Task id for polling status","$$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"post","path":"/multicloud/cloudgateway"}}