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

000Operation status unknownopenvpn.connection may have this status when the VPN Client is still retrieving the OpenVPN configuration in the ixapi.openvpn_configuration step.
001Operation is not applicablestunnel.connection may have this status when Stealth Mode has not been enabled.
002Operation is pendingopenvpn.connection may have this status when it is currently setting up a connection
003Operation completed succesfullyixapi.discovery may have this status after the Discovery has been successfully retrieved.
004Operation is activeopenvpn.connection may have this status when the OpenVPN connection is active. 004 is comparable with 003, with the only difference being that 004 is used for scenarios when an operation is successfully active rather than has been successfully completed.

Status codes >=010: error

010Operation completed with an unknown errorUsed as a generic error message when a more detailed error is not available.
1XYIXapi Discovery related errors.
2XYIXapi Agent Information related errors.
3XYIXapi VPN Configuration related errors.
5XYProxy related errors.
6XYStunnel related errors.
7XYOpenVPN related errors.
8XYRoutes (LAN) related errors.
9XYRoutes (Subnet) related errors.