Vpn Resource

GET /vpn/connections

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

Response Body
media type data type description
application/json VpnConnectionsResult (JSON) The list of active VpnConnections.
application/xml vpnConnectionsResult (XML)

Example

Request
GET /vpn/connections
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vpnConnection" : [ {
    "id" : 12345,
    "accountId" : 12345,
    "createdOn" : 12345,
    "modifiedOn" : 12345,
    "userId" : 12345,
    "deviceId" : "...",
    "inetAddress" : "...",
    "optlock" : 12345
  }, {
    "id" : 12345,
    "accountId" : 12345,
    "createdOn" : 12345,
    "modifiedOn" : 12345,
    "userId" : 12345,
    "deviceId" : "...",
    "inetAddress" : "...",
    "optlock" : 12345
  } ]
}

POST /vpn/connect/{clientId}

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.

Request Parameters
name type description
clientId path The client ID of the device whose VPN connect is requested.
Response Body
media type data type description
application/json VpnClientStatus (JSON) The resulting VpnClientStatus object.
application/xml vpnClientStatus (XML)

Example

Request
POST /vpn/connect/{clientId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "connected" : true,
  "ipAddress" : "..."
}

GET /vpn/connections/{vpnConnectionId}

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

Request Parameters
name type description constraints
vpnConnectionId path The Id of the VpnConnection requested. required
Response Body
media type data type description
application/json VpnConnection (JSON) The requested VpnConnection object.
application/xml vpnConnection (XML)

Example

Request
GET /vpn/connections/{vpnConnectionId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : 12345,
  "accountId" : 12345,
  "createdOn" : 12345,
  "modifiedOn" : 12345,
  "userId" : 12345,
  "deviceId" : "...",
  "inetAddress" : "...",
  "optlock" : 12345
}

POST /vpn/disconnect/{clientId}

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.

Request Parameters
name type description
clientId path The client ID of the device whose VPN disconnect is requested.
Response Body
media type data type description
application/json VpnClientStatus (JSON) The resulting VpnClientStatus object.
application/xml vpnClientStatus (XML)

Example

Request
POST /vpn/disconnect/{clientId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "connected" : true,
  "ipAddress" : "..."
}

GET /vpn/status/{clientId}

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.

Request Parameters
name type description
clientId path The client ID of the device whose VPN connection status is requested.
Response Body
media type data type description
application/json VpnClientStatus (JSON) The requested VpnClientStatus object.
application/xml vpnClientStatus (XML)

Example

Request
GET /vpn/status/{clientId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "connected" : true,
  "ipAddress" : "..."
}