IXON-API

IXON API documentation

Welcome to the IXON development website. Curious about our API endpoints? Take a look at our endpoint list, you can try-out the API in that section as well. Do you need some guidance on how to use our API? Take a look at the API Documentation. Take a look at our release notes if you're curious what has changed to the API.

Endpoint List    Release Notes

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 an example of a possible connection status response is give 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 \
--insecure \
--header "Connection: Upgrade" \
--header "Upgrade: websocket" \
--header "Sec-WebSocket-Key: GUID" \
--header "Sec-WebSocket-Version: 13" \
https://localhost:9250/

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

Description

Example

000

Operation status unknown

openvpn.connection may have this status when the VPN Client is still retrieving the OpenVPN configuration in the ixapi.openvpn_configuration step.

001

Operation is not applicable

stunnel.connection may have this status when Stealth Mode has not been enabled.

002

Operation is pending

openvpn.connection may have this status when it is currently setting up a connection

003

Operation completed succesfully

ixapi.discovery may have this status after the Discovery has been successfully retrieved.

004

Operation is active

openvpn.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

Status

Description

Example

010

Operation completed with an unknown error

Used as a generic error message when a more detailed error is not available.

1XY

IXapi Discovery related errors.

2XY

IXapi Agent Information related errors.

3XY

IXapi VPN Configuration related errors.

5XY

Proxy related errors.

6XY

Stunnel related errors.

7XY

OpenVPN related errors.

8XY

Routes (LAN) related errors.

9XY

Routes (Subnet) related errors.

Updated 8 months ago


VPN Client status


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.