Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

CloudExpress Service

API calls for configuring CloudExpress service:

Activate CloudExpress Service

Activate new CloudExpress service.

URL: https://vmanage-ip-address/dataservice/template/device/config/attachcloudx

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
deviceTemplateJSON Yes Parameters for template enable action Body
See Request Body Schema Table, below, for details
String

Request Content Type: application/json

Request Body Schema

Value Description
isEdited Use the value false to indicate that this is a new CloudExpress configuration.
siteList List of sites on which to enable CloudExpress service by site identifier.
siteType Site type. The value dia indicates Direct Internet Access sites. The value client indicates client sites. The value gateway indicates gateway sites.

Example Request and Response

Enabling a CloudExpress template is a two-step process:

  1. Issue the POST call to initiate the action:
{
  "isEdited":false,
  "siteList":[
    400
  ],
  "siteType":"dia"
}

The response contains the process ID for activating CloudExpress service:

{"id":"push_file_template_configuration-01242017T020647984"}
  1. Issue a monitor device action status call with the process ID to display the status of activating CloudExpress service:
https://vmanage-ip-address/dataservice/device/action/status/push_file_template_configuration-01242017T020647984

The second response object retrieves the detailed action status.

Deactivate CloudExpress Service

Deactivate CloudExpress service.

URL: https://vmanage-ip-address/dataservice/template/device/config/detachcloudx

Method: POST

Request Parameters

Name Required Description Parameter Type Data Type
deviceTemplateJSON Yes Parameters for deactivating CloudExpress service action Body
See Request Body Schema Table, below, for details
String

Request Content Type: application/json

Request Body Schema

Value Description
siteList List of sites to detach by site identifier.
siteType Site type. The value none removes these sites from the CloudExpress configuration.

Example Request and Response

Deactivating CloudExpress service is a two-step process:

  1. Issue the POST call to initiate the deactivate action:
{"siteList":[400],"siteType":"none"}

The response contains the process ID for the deactivate action:

{"id":"push_file_template_configuration-01242017T020647984"}
  1. Issue a monitor device action status call with the process ID to display the status of the deactivate action:
https://vmanage-ip-address/dataservice/device/action/status/push_file_template_configuration-01242017T020647984

The second response object retrieves the detailed action status.

Edit CloudExpress Service

Edit an existing CloudExpress configuration.

URL: https://vmanage-ip-address/dataservice/template/device/config/attachcloudx

Method: PUT

Request Parameters

Name Required Description Parameter Type Data Type
deviceTemplateJSON Yes Parameters for template edit action Body
See Request Body Schema Table, below, for details
String

Request Content Type: application/json

Request Body Schema

Value Description
isEdited Use the value true to indicate that CloudExpress applications or interfaces have been modified. 
siteList List of sites to edit by site identifier.
siteType Site type. The value dia indicates a Direct Internet Access site. The value client indicates a client site. The value gateway indicates a gateway site.

Example Request and Response

Editing CloudExpress service is a two-step process:

  1. Issue the PUT call to initiate the edit action:
{
  "isEdited":true,
  "siteList":[
    400,500
  ],
  "siteType":"dia"
}

The response contains the process ID for the edit action:

{"id":"push_file_template_configuration-01242017T020647984"}
  1. Issue a monitor device action status call with the process ID to display the status of the edit action:
https://vmanage-ip-address/dataservice/device/action/status/push_file_template_configuration-01242017T020647984

The second response object retrieves the detailed action status.

Additional Information

Using the vManage REST API

  • Was this article helpful?