VPN Client status

You can obtain the current connection status of your VPN Client using the status endpoint. The example below shows you what that request should look like.

curl --request GET \
     --url 'https://localhost:9250/status'

An example of a possible connection status response is given below. In this example the status is idle.

{
  "status": "idle",
  "activeRequest": ""
}

Status WebSocket

There is a status WebSocket connection available at wss://localhost:9250/. The status will be posted to each connected WebSocket client each time it changes. For example, the IXON Cloud uses a WebSocket connection to keep its status synchronized with the VPN Client.

Examples of the status object can be found in the example above. The status object returned by the /status endpoint and the WebSocket connection are the same, the only difference is that the WebSocket will push a new status object each time it changes (push), whereas the /status endpoint has to be queried manually (pull).

curl --request GET \
     --url 'https://localhost:9250/' \
     --insecure \
     --header "Connection: Upgrade" \
     --header "Upgrade: websocket" \
     --header "Sec-WebSocket-Key: GUID" \
     --header "Sec-WebSocket-Version: 13"

Status codes

The status object format is subject to change and still in active development. As such, a complete list of every status code has been omitted as such a list would quickly become out of date. Nonetheless, the status codes can be categorized as follows:

Status codes <010: Generic and informational

Status codes >=010: error