{"type":"api","title":"Update 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":"Update cloud gateway","operationId":"updateCgw","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"required":["accountId","cloudGatewayName","cloudType","region","resourceGroupName","vhubId"],"type":"object","properties":{"accountId":{"type":"string"},"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"},"cloudGatewayName":{"pattern":"^[\\w.-]{1,128}$","type":"string"},"cloudType":{"pattern":"^[a-zA-Z_]+$","type":"string"},"description":{"type":"string"},"deviceChanges":{"type":"object","properties":{"devicesAdded":{"type":"array","items":{"type":"string"}},"devicesDeleted":{"type":"array","items":{"type":"string"}}},"description":"Used for GCP updateCgw","$$ref":"#/components/schemas/UpdateCgwDeviceChanges"},"devices":{"type":"array","description":"Used for AZURE updateCgw","items":{"type":"string","description":"Used for AZURE updateCgw"}},"mrfRouterRole":{"pattern":"^(border|edge)$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroupName":{"pattern":"^[\\w.-]{1,128}$","type":"string","description":"Used for AZURE updateCgw"},"s2sPermitted":{"pattern":"^(true|false)$","type":"string","description":"Used for GCP updateCgw"},"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/AllOfupdateCgwSettings"},"vhubId":{"type":"string","description":"Used for AZURE updateCgw"}},"$$ref":"#/components/schemas/UpdateCgw"},"examples":{"GCP CGW CGW update":{"description":"GCP CGW CGW update","value":{"cloudType":"GCP","accountId":"gcp-project-nprd-31900","region":"us-west4","s2sPermitted":true,"mrfRouterRole":"border","deviceChanges":{"devicesAdded":["C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"devicesDeleted":[]}}},"AWS/AWS GovCloud CGW update":{"description":"AWS/AWS GovCloud CGW update","value":{"cloudType":"AWS","mrfRouterRole":"border","settings":{"tunnelCount":3}}},"AZURE/AZURE GovCloud CGW update":{"description":"AZURE/AZURE GovCloud CGW update","value":{"cloudType":"AZURE","accountId":"8b188c39-f358-4db6-a44f-84068541233a","region":"westus2","cloudGatewayName":"az-test","mrfRouterRole":"border","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-D4821270-27FF-A1B0-B902-12A321E3A550"],"description":"","resourceGroupName":"test-resource-group","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","settings":{"cloudType":"AZURE","name":"AZURE_CUSTOM_SETTINGS","ipSubnetPool":"10.0.0.0/16","skuScaleUnit":4,"softwareImageId":"17.6.01"}}}}}},"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":"put","path":"/multicloud/cloudgateway/{cloudGatewayName}"}}