UX 1.0 Configuration

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

Table of Contents

Breaking changes (39)

• [Configuration - Azure Connect]
  • GET /template/cortex
  • POST /template/cortex/cloud/authenticate
  • GET /template/cortex/map
  • POST /template/cortex/sync
  • DELETE /template/cortex/wanrg
  • GET /template/cortex/wanrg
  • POST /template/cortex/wanrg
  • PUT /template/cortex/wanrg
• [Configuration - Cloud On Ramp]
  • GET /template/cor
  • POST /template/cor
  • DELETE /template/cor/accountid/{accountid}
  • POST /template/cor/acquireResourcePool
  • GET /template/cor/ami
  • GET /template/cor/cloud
  • GET /template/cor/cloud/account
  • POST /template/cor/cloud/authenticate
  • PUT /template/cor/cloud/authenticate
  • GET /template/cor/cloud/host/accountdetails
  • GET /template/cor/cloud/mappedhostaccounts
  • POST /template/cor/createResourcePool
  • DELETE /template/cor/deleteDevicepair
  • GET /template/cor/device
  • POST /template/cor/devicepair
  • GET /template/cor/devicepair/hostvpc
  • GET /template/cor/getTransitDevicePairAndHostList
  • GET /template/cor/getTransitVpnList
  • GET /template/cor/hostvpc
  • DELETE /template/cor/map
  • GET /template/cor/map
  • POST /template/cor/map
  • GET /template/cor/pem
  • POST /template/cor/scale/down
  • POST /template/cor/scale/up
  • GET /template/cor/transitvpc
  • POST /template/cor/transitvpc
  • PUT /template/cor/transitvpc
  • PUT /template/cor/transitvpc/autoscale-properties
  • GET /template/cor/transitvpc/size
  • GET /template/cor/externalId

New (1)

• [Configuration - vSmart Template Policy]
  • GET /template/policy/vsmart/definition/activateIds

Deprecated (4)

• [Configuration - General Template]
  • POST /template/feature/resource-group/{resourceGroupName}/{templateId}
• [Configuration - Template Configuration]
  • GET /template/config/diff/{deviceId}
• [Configuration - Template Master]
  • POST /template/device/resource-group/{resourceGroupName}/{templateId}
• [Configuration - vEdge Template Policy]
  • POST /template/policy/vedge/{resourceGroupName}/{policyId}

Updates (2)

• [Configuration - Cloud On Ramp]
  • GET /template/cor/externalId
• [Configuration - General Template]
  • GET /template/feature/object/{templateId}

Breaking changes

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

[Configuration - Azure Connect]

• GET /template/cortex
  • API Operation Summary: Get Cortex List
  • ⛔️ Breaking Change - Removed operation
• POST /template/cortex/cloud/authenticate
  • API Operation Summary: Authenticate Cloud Account Credentials
  • ⛔️ Breaking Change - Removed operation
• GET /template/cortex/map
  • API Operation Summary: Get Mapped WAN Resource Groups
  • ⛔️ Breaking Change - Removed operation
• POST /template/cortex/sync
  • API Operation Summary: Sync WAN Resource Groups
  • ⛔️ Breaking Change - Removed operation
• DELETE /template/cortex/wanrg
  • API Operation Summary: Delete WAN Resource Groups
  • ⛔️ Breaking Change - Removed operation
• GET /template/cortex/wanrg
  • API Operation Summary: Get WAN Resource Groups
  • ⛔️ Breaking Change - Removed operation
• POST /template/cortex/wanrg
  • API Operation Summary: Create WAN Resource Groups
  • ⛔️ Breaking Change - Removed operation
• PUT /template/cortex/wanrg
  • API Operation Summary: Edit WAN Resource Groups
  • ⛔️ Breaking Change - Removed operation

[Configuration - Cloud On Ramp]

• GET /template/cor
  • API Operation Summary: Get Cloud On Ramp list
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor
  • API Operation Summary: Map Host to Transit VPC/VNet
  • ⛔️ Breaking Change - Removed operation
• DELETE /template/cor/accountid/{accountid}
  • API Operation Summary: Delete transit VPC/VNet
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/acquireResourcePool
  • API Operation Summary: Acquire IP from resource pool
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/ami
  • API Operation Summary: Get AMI list
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/cloud
  • API Operation Summary: Get cloud list
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/cloud/account
  • API Operation Summary: Get cloud accounts
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/cloud/authenticate
  • API Operation Summary: Authenticate cloud account credentials
  • ⛔️ Breaking Change - Removed operation
• PUT /template/cor/cloud/authenticate
  • API Operation Summary: Authenticate and update cloud account credentials
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/cloud/host/accountdetails
  • API Operation Summary: Get cloud host VPC account details
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/cloud/mappedhostaccounts
  • API Operation Summary: Get cloud mapped accounts view
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/createResourcePool
  • API Operation Summary: Add resource pool
  • ⛔️ Breaking Change - Removed operation
• DELETE /template/cor/deleteDevicepair
  • API Operation Summary: Remove device pair
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/device
  • API Operation Summary: Get available device list
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/devicepair
  • API Operation Summary: Add device pair
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/devicepair/hostvpc
  • API Operation Summary: Get host VPC details
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/getTransitDevicePairAndHostList
  • API Operation Summary: Get device and host details
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/getTransitVpnList
  • API Operation Summary: Get transit VPN list
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/hostvpc
  • API Operation Summary: Get host VPC/VNet list
  • ⛔️ Breaking Change - Removed operation
• DELETE /template/cor/map
  • API Operation Summary: Unmap host from transit VPC/VNet
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/map
  • API Operation Summary: Get mapped VPC/VNet list
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/map
  • API Operation Summary: Map host to transit VPC/VNet
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/pem
  • API Operation Summary: Get transit VPC PEM key list
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/scale/down
  • API Operation Summary: Scale down cloud on ramp
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/scale/up
  • API Operation Summary: Scale up cloud on ramp
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/transitvpc
  • API Operation Summary: Get transit VPC/VNet list
  • ⛔️ Breaking Change - Removed operation
• POST /template/cor/transitvpc
  • API Operation Summary: Create transit VPC/VNet
  • ⛔️ Breaking Change - Removed operation
• PUT /template/cor/transitvpc
  • API Operation Summary: Update transit VPC/VNet
  • ⛔️ Breaking Change - Removed operation
• PUT /template/cor/transitvpc/autoscale-properties
  • API Operation Summary: Update transit VPC autoscale properties
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/transitvpc/size
  • API Operation Summary: Get transit VPC supported size
  • ⛔️ Breaking Change - Removed operation
• GET /template/cor/externalId
  • API Operation Summary: Get the vManage external ID for AWS
  • ⛔️ Breaking Change - the response's body type/format changed from 'array'/'' to 'object'/'' for status '200'

New

The following operations are introduced with this release:

[Configuration - vSmart Template Policy]

• GET /template/policy/vsmart/definition/activateIds
  • New operation: Get all active policy IDs that include all tenants

Deprecated

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

[Configuration - General Template]

• POST /template/feature/resource-group/{resourceGroupName}/{templateId}
  • ⚠️ Deprecated operation: Change template resource group

[Configuration - Template Configuration]

• GET /template/config/diff/{deviceId}
  • ⚠️ Deprecated operation: Generates a JSON object that contains the diff for a given device

[Configuration - Template Master]

• POST /template/device/resource-group/{resourceGroupName}/{templateId}
  • ⚠️ Deprecated operation: Change template resource group

[Configuration - vEdge Template Policy]

• POST /template/policy/vedge/{resourceGroupName}/{policyId}
  • ⚠️ Deprecated operation: Change policy resource group

Updates

[Configuration - Cloud On Ramp]

• GET /template/cor/externalId
  • API Operation Summary: Get the vManage external ID for AWS
  • ⛔️ Breaking Change -the response's body type/format changed from 'array'/'' to 'object'/'' for status '200'

[Configuration - General Template]

• GET /template/feature/object/{templateId}
  • API Operation Summary: Get template object definition for given template Id
    
    
    Note: In a multitenant vManage system, this API is only available in the Provider view.
  • added the new optional 'query' request parameter 'metadata'