SD-WAN Services

The following sections describe the API changes from version 26.1 to 26.2.

Table of Contents

Breaking changes (59)

• [Configuration - Multi Cloud]
  • GET /multicloud/accounts/edge
  • POST /multicloud/accounts/edge
  • DELETE /multicloud/accounts/edge/{accountId}
  • GET /multicloud/accounts/edge/{accountId}
  • PUT /multicloud/accounts/edge/{accountId}
  • PUT /multicloud/accounts/edge/{accountId}/credentials
  • GET /multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}
  • GET /multicloud/cloudRoutersAndAttachments
  • GET /multicloud/connected-sites/edge/{edgeType}
  • GET /multicloud/connectivity/edge
  • POST /multicloud/connectivity/edge
  • PUT /multicloud/connectivity/edge
  • DELETE /multicloud/connectivity/edge/{connectionName}
  • GET /multicloud/connectivity/edge/{connectionName}
  • DELETE /multicloud/connectivitygateway
  • GET /multicloud/connectivitygateway
  • POST /multicloud/connectivitygateway
  • DELETE /multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}
  • GET /multicloud/connectivitygatewaycreationoptions
  • GET /multicloud/dashboard/edge
  • GET /multicloud/devicelink/edge
  • POST /multicloud/devicelink/edge
  • PUT /multicloud/devicelink/edge
  • GET /multicloud/devicelink/edge/portspeed/{edgeType}
  • DELETE /multicloud/devicelink/edge/{deviceLinkName}
  • POST /multicloud/devicelink/metroSpeed/edge
  • GET /multicloud/devices/edge/{edgeType}
  • GET /multicloud/edge/{edgeType}/device
  • GET /multicloud/gateway/edge
  • POST /multicloud/gateway/edge
  • GET /multicloud/gateway/edge/setting/{edgeGatewayName}
  • GET /multicloud/gateway/edge/types
  • DELETE /multicloud/gateway/edge/{edgeGatewayName}
  • GET /multicloud/gateway/edge/{edgeGatewayName}
  • PUT /multicloud/gateway/edge/{edgeGatewayName}
  • GET /multicloud/gateways/edge/{edgeType}
  • GET /multicloud/imagename/edge
  • GET /multicloud/instancesize/edge
  • GET /multicloud/license/edge
  • DELETE /multicloud/locations/edge/{edgeType}
  • GET /multicloud/locations/edge/{edgeType}
  • PUT /multicloud/locations/edge/{edgeType}/accountId/{accountId}
  • GET /multicloud/loopbackCGWColor/edge
  • GET /multicloud/loopbacktransportcolor/edge
  • GET /multicloud/map/tags/edge
  • GET /multicloud/partnerports/edge
  • GET /multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}
  • GET /multicloud/settings/edge/global
  • POST /multicloud/settings/edge/global
  • PUT /multicloud/settings/edge/global
  • GET /multicloud/types/edge
  • GET /multicloud/vhubs
  • POST /multicloud/vwan
  • DELETE /multicloud/vwan/{cloudProvider}/{vWanName}
  • GET /multicloud/vwans
  • GET /multicloud/widget/edge
  • GET /multicloud/widget/edge/{edgeType}
• [System - Cloud Service]
  • GET /dca/cloudservices
  • GET /dca/cloudservices/otp

New (2)

• [Data Collection Agent]
  • GET /dca/cloudservices/dcscapabilities
  • GET /dca/settings/configuration/{type}/dca

Deprecated (1)

• [Data Collection Agent]
  • GET /dca/settings/configuration/cloudservices/dca

Updates (2)

• [System - Cloud Service]
  • GET /dca/cloudservices
  • GET /dca/cloudservices/otp

Breaking changes

The following are changes to the API that may break an application or integration.

[Configuration - Multi Cloud]

• GET /multicloud/accounts/edge
  • API Operation Summary: Get all Multicloud edge accounts
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/accounts/edge
  • API Operation Summary: Authenticate edge account credentials
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/accounts/edge/{accountId}
  • API Operation Summary: Delete edge account
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/accounts/edge/{accountId}
  • API Operation Summary: Get edge account by account Id
  • ⛔️ Breaking Change - Removed operation
• PUT /multicloud/accounts/edge/{accountId}
  • API Operation Summary: Update Multicloud edge account
  • ⛔️ Breaking Change - Removed operation
• PUT /multicloud/accounts/edge/{accountId}/credentials
  • API Operation Summary: Update Multicloud edge account credential
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}
  • API Operation Summary: Get Edge Billing Accounts
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/cloudRoutersAndAttachments
  • API Operation Summary: Get all Cloud Routers and their Attachments
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/connected-sites/edge/{edgeType}
  • API Operation Summary: Get sites with connectivity to the interconnect gateways by edge type
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/connectivity/edge
  • API Operation Summary: Get Interconnect Connectivity details
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/connectivity/edge
  • API Operation Summary: Create Interconnect connectivity
  • ⛔️ Breaking Change - Removed operation
• PUT /multicloud/connectivity/edge
  • API Operation Summary: Update Interconnect connectivity
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/connectivity/edge/{connectionName}
  • API Operation Summary: Delete Interconnect connectivity
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/connectivity/edge/{connectionName}
  • API Operation Summary: Get Interconnect Connectivity by name
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/connectivitygateway
  • API Operation Summary: Delete all Connectivity Gateways in local DB
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/connectivitygateway
  • API Operation Summary: Get all Connectivity Gateways
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/connectivitygateway
  • API Operation Summary: Create Connectivity gateway
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}
  • API Operation Summary: Delete Connectivity Gateway
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/connectivitygatewaycreationoptions
  • API Operation Summary: Get connectivity gateway creation options
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/dashboard/edge
  • API Operation Summary: Get interconnect edge gateway dashboard info
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/devicelink/edge
  • API Operation Summary: Get Device Links
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/devicelink/edge
  • API Operation Summary: Create Device Link
  • ⛔️ Breaking Change - Removed operation
• PUT /multicloud/devicelink/edge
  • API Operation Summary: Update Device Link
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/devicelink/edge/portspeed/{edgeType}
  • API Operation Summary: Get supported port speed for Device Link
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/devicelink/edge/{deviceLinkName}
  • API Operation Summary: Delete Device Link
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/devicelink/metroSpeed/edge
  • API Operation Summary: Get Device Link Metro Speed based on device link config
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/devices/edge/{edgeType}
  • API Operation Summary: Get cloud devices by cloud type
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/edge/{edgeType}/device
  • API Operation Summary: Get available WAN edge devices
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/gateway/edge
  • API Operation Summary: Get Interconnect Gateways
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/gateway/edge
  • API Operation Summary: Create Interconnect Gateway
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/gateway/edge/setting/{edgeGatewayName}
  • API Operation Summary: Get Interconnect Gateway custom setting by Interconnect Gateway name
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/gateway/edge/types
  • API Operation Summary: Get Interconnect Gateway type for specified Edge Provider
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/gateway/edge/{edgeGatewayName}
  • API Operation Summary: Delete Interconnect Gateway
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/gateway/edge/{edgeGatewayName}
  • API Operation Summary: Get Interconnect Gateway by name
  • ⛔️ Breaking Change - Removed operation
• PUT /multicloud/gateway/edge/{edgeGatewayName}
  • API Operation Summary: Update Interconnect Gateway
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/gateways/edge/{edgeType}
  • API Operation Summary: Get sites with connectivity to the interconnect gateways by edge type
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/imagename/edge
  • API Operation Summary: Get Edge provider supported images
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/instancesize/edge
  • API Operation Summary: Get Edge provider supported size
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/license/edge
  • API Operation Summary: Get License Info for Edge Gateways/Connections
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/locations/edge/{edgeType}
  • API Operation Summary: Delete edge account
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/locations/edge/{edgeType}
  • API Operation Summary: Get Edge Locations
  • ⛔️ Breaking Change - Removed operation
• PUT /multicloud/locations/edge/{edgeType}/accountId/{accountId}
  • API Operation Summary: Update Edge Locations
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/loopbackCGWColor/edge
  • API Operation Summary: Get Edge Loopback CGW supported colors
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/loopbacktransportcolor/edge
  • API Operation Summary: Get Edge Loopback Tunnel supported colors
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/map/tags/edge
  • API Operation Summary: Get default Interconnect mapping tag values
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/partnerports/edge
  • API Operation Summary: Get partner ports
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}
  • API Operation Summary: Get supported port speed
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/settings/edge/global
  • API Operation Summary: Get edge global settings
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/settings/edge/global
  • API Operation Summary: Add global settings for Edge provider
  • ⛔️ Breaking Change - Removed operation
• PUT /multicloud/settings/edge/global
  • API Operation Summary: Update edge global settings for Edge provider
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/types/edge
  • API Operation Summary: Get edge types
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/vhubs
  • API Operation Summary: Get Virtual Hubs
  • ⛔️ Breaking Change - Removed operation
• POST /multicloud/vwan
  • API Operation Summary: Create Virtual WAN
  • ⛔️ Breaking Change - Removed operation
• DELETE /multicloud/vwan/{cloudProvider}/{vWanName}
  • API Operation Summary: Delete Virtual Wan
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/vwans
  • API Operation Summary: Get Virtual Wans
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/widget/edge
  • API Operation Summary: Get All Interconnect Edge widgets
  • ⛔️ Breaking Change - Removed operation
• GET /multicloud/widget/edge/{edgeType}
  • API Operation Summary: Get Interconnect Edge widget by edge type
  • ⛔️ Breaking Change - Removed operation

[System - Cloud Service]

• GET /dca/cloudservices
  • API Operation Summary: Get cloud service settings
  • ⛔️ Breaking Change - removed the media type 'application/octet-stream' for the response with the status '200'
• GET /dca/cloudservices/otp
  • API Operation Summary: Get cloud service OTP value
  • ⛔️ Breaking Change - removed the media type 'application/octet-stream' for the response with the status '200'

New

The following operations are introduced with this release:

[Data Collection Agent]

• GET /dca/cloudservices/dcscapabilities
  • New operation: Get DCS file capability information
• GET /dca/settings/configuration/{type}/dca
  • New operation: Get DCA service configuration

Deprecated

The following operations and properties will be removed in future releases. Therefore, it is not recommended to use these resources.

[Data Collection Agent]

• GET /dca/settings/configuration/cloudservices/dca
  • ⚠️ Deprecated operation: Get DCA cloud service configuration

Updates

[System - Cloud Service]

• GET /dca/cloudservices
  • API Operation Summary: Get cloud service settings
  • ⛔️ Breaking Change -removed the media type 'application/octet-stream' for the response with the status '200'
  • added the media type 'application/json' for the response with the status '200'
• GET /dca/cloudservices/otp
  • API Operation Summary: Get cloud service OTP value
  • ⛔️ Breaking Change -removed the media type 'application/octet-stream' for the response with the status '200'
  • added the media type 'application/json' for the response with the status '200'