Vpn

The following resources are applicable:

/vpn/connect/{clientId}

Mount Point: /v2/vpn/connect/{clientId}

POST

Sends a VPN connect request to the device identified by the specified clientId. To be able to process the request, the device must be connected to the Everyware Cloud and have the Everyware Software Framework with the VPN Remote Access bundle installed and configured. Upon receiving the request, the device will start a VPN connection to the specified VPN server. The call returns the status of the VPN Connection of such device at the end of the operation.

Parameters

name description type default
clientId The client ID of the device whose VPN connect is requested. path

Response Body

element: vpnClientStatus
media types: application/xml
application/json

The resulting VpnClientStatus object.

/vpn/connections

Mount Point: /v2/vpn/connections

GET

Returns the list of all the VpnConnection currently active under this account.

Response Body

element: vpnConnectionsResult
media types: application/xml
application/json

The list of active VpnConnections.

/vpn/connections/{vpnConnectionId}

Mount Point: /v2/vpn/connections/{vpnConnectionId}

GET

Returns the details of the VpnConnection specified by the "vpnConnectionId" path parameter.

Parameters

name description type default
vpnConnectionId The Id of the VpnConnection requested. path

Response Body

element: vpnConnection
media types: application/xml
application/json

The requested VpnConnection object.

/vpn/disconnect/{clientId}

Mount Point: /v2/vpn/disconnect/{clientId}

POST

Sends a VPN disconnect request to the device identified by the specified clientId. To be able to process the request, the device must be connected to the Everyware Cloud and have the Everyware Software Framework with the VPN Remote Access bundle installed and configured. Upon receiving the request, the device will stop the current VPN connection if one is active. The call returns the status of the VPN Connection of such device at the end of the operation.

Parameters

name description type default
clientId The client ID of the device whose VPN disconnect is requested. path

Response Body

element: vpnClientStatus
media types: application/xml
application/json

The resulting VpnClientStatus object.

/vpn/status/{clientId}

Mount Point: /v2/vpn/status/{clientId}

GET

Returns the VPN connection status for the device identified by the specified clientId. To be able to process the request, the device must be connected to the Everyware Cloud and have the Everyware Software Framework with the VPN Remote Access bundle installed and configured. The call returns the status of the VPN Connection of such device at the end of the operation.

Parameters

name description type default
clientId The client ID of the device whose VPN connection status is requested. path

Response Body

element: vpnClientStatus
media types: application/xml
application/json

The requested VpnClientStatus object.