Device VPN Connections
This page is a work in progress
This group of REST API allows performing VPN operations on the remote device. Note that to be able to process these requests the device must be connected to the Everyware Cloud and have the Everyware Software Framework with the VPN Remote Access bundle installed and configured.
For more information about VPN Connections, please read VPN Servers
Get the VPN Client Status
The following API allows one to retrieve the VPN client status:
GET /{scopeId}/devices/{deviceId}/vpn
The required path parameters to be used with this call are:
{scopeId}
is thescopeId
of the tenant (account) to which the desired device belongs and can be retrieved from the response of the authentication call; the "_" character can be used for indicating thescopeId
of the user currently authenticated with the token;{deviceId}
is the id of the desired device.
Response
The response of this call will contain the status of the VPN connection of the given device. As an example:
{
"connected": true,
"ipAddress": "10.200.12.49"
}
Connect the VPN Client
The following API allows connecting the VPN client on the desired device (more precisely, it sends a message to the device telling it to connect to the VPN server):
POST /{scopeId}/devices/{deviceId}/vpn/_connect
The required path parameters to be used with this call are:
{scopeId}
is thescopeId
of the tenant (account) to which the desired device belongs and can be retrieved from the response of the authentication call; the "_" character can be used for indicating thescopeId
of the user currently authenticated with the token;{deviceId}
is the id of the desired device.
Response
The response of this call will contain the status of the VPN connection of the given device. As an example:
{
"connected": true,
"ipAddress": "10.200.12.49"
}
Disconnect the VPN Client
The following API allows disconnecting the VPN client on the desired device (more precisely it sends a message to the device telling it to disconnect from the VPN server):
POST /{scopeId}/devices/{deviceId}/vpn/_discconect
The required path parameters to be used with this call are:
{scopeId}
is thescopeId
of the tenant (account) to which the desired device belongs and can be retrieved from the response of the authentication call; the "_" character can be used for indicating thescopeId
of the user currently authenticated with the token;{deviceId}
is the id of the desired device.
Response
The response of this call will contain the status of the VPN connection of the given device. As an example:
{
"connected": false,
"ipAddress": "0.0.0.0"
}
Updated about 5 years ago