VPNWholesaler.com multi-platform in-app VPN SDK

Unified in-app VPN SDK's for Microsoft Windows Vista+, Android 4.4+, Mac OS 10.7+, iOS 9.0+, Ubuntu Linux LTS 18.04+. Earlier OS versions can be supported as well by request. Please contact [email protected] to receive your own API key.

Copyright © 2019 VPNWholesaler.com. All rights reserved.

Content

1. Getting started
   1. Windows C++
   2. Windows C#
   3. OS X
   4. Android
   5. iOS
   6. Linux Ubuntu
2. Generic interface
   1. Initialize SDK
   2. Finalize SDK
   3. Send command
3. SDK Commands
   1. Login
   2. Get servers list (Deprecated)
   3. Get servers list by geolocation
   4. Get servers list by country
   5. Check internet connection
   6. Get device ID
   7. Check open port
   8. Set API domain
   9. Set API key
   10. Get ping
   11. Check AES support
   12. Set encryption
   13. Enable or disable IO counter
   14. Get current profile
   15. Get account type
   16. Get account credentials
   17. Get account expiration date
   18. Set XOR mode
   19. Set logger mode
   20. Start VPN connection
   21. Stop VPN connection
   22. Get VPN status
   23. Add client
   24. Remove client
   25. Reset password
   26. Enable IKEv2 Mode (Deprecated)
   27. Start IKEv2 VPN connection (Deprecated)
   28. Stop IKEv2 VPN connection (Deprecated)
   29. Get IKEV2 VPN status (Deprecated)
   30. Check TAP adapter status
   31. Logout
   32. Switch VPN server
   33. Disable IPv6
   34. Set Binary path
   35. Change Plan
   36. Set VPN Type

1. Getting started

1. Windows C++

Minimum OS version supported: Windows XP

Development tools recommended: Visual Studio 2015 - Windows XP (v140_xp)

To add SDK static lib to your project:

1. Download the static library from Google Drive
2. Unpack downloaded archive to a folder.
3. Find "kucore.lib" and "CoreAPI.h" files.
4. Place "kucore.lib" to a folder that contains the other static libraries of your project, or alternatively create a new folder named "Libs" in your project directory and place the file there.
5. Place "CoreAPI.h" to your project's folder that contains the other header files.
6. Add new input dependency "CoreAPI.h" in your linker. For example, in MS Visual Studio: Project->Properties->Linker->Input->Additional Dependencies.
7. Add #include "CoreAPI.h" to the file where you plan to use the SDK commands.

2. Windows C#

.Net Framework supported: 3.5, 4.5

Development tools recommended: Visual Studio 2015

Please follow the steps below to use SDK as a part of a .NET project:

1. Download dynamic library with dependencies from Google Drive

2. Define callback signature. This callback will be invoked from SDK when request result is ready. Please note that all operations in the SDK are called asynchronously and callback is invoked in the thread associated with SDK.

   [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
   public delegate bool Callback([MarshalAs(UnmanagedType.LPStr)]string Mesg);
   
   Callback callback = new Callback(CallbackHandler);
   
   public bool CallbackHandler(String value)
   {
       Console.WriteLine(‘callback data = ‘ + value);
   }
   

3. Import main SDK methods from DLL:

   [DllImport("kucore.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
   public static extern void CmdProc(String param);
   
   [DllImport("kucore.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
   
   public static extern int InitOVSCore([MarshalAs(UnmanagedType.FunctionPtr)] Callback callbackPointer, String ovpn_path, bool isIKEv2Mode);
   [DllImport("kucore.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
   public static extern void FinalizeOVSCore();
   

4. Use the SDK methods in the same manner as a C++ project

Please refer to a Sample C# In-app VPN SDK Demo Project and Instructions

3. OS X

Minimum OS version supported: OS X 10.7

Development tools recommended: X Code 9.4

To add SDK static lib to your project:

1. Download static library from Google Drive
2. Unpack downloaded archive to your project's folder
3. Add libkucore.a file in Linked Framework and Libraries in project General setting page
4. Add #include "CoreAPI.h" to the file where you are going to use SDK commands.

4. Android

Minimum OS version supported: Android KitKat API 19

Development tools recommended: Android Studio

To add SDK library to your project:

1. Download library from Google Drive
2. Unpack downloaded archive to libs subfolder of your application

3. Add the following lines to your application build.gradle:

   implementation fileTree(include: ['vpnsdk-release.aar'], dir: 'libs')
   implementation 'com.squareup.retrofit2:retrofit:2.3.0'
   implementation 'com.squareup.retrofit2:converter-gson:2.3.0'
   implementation 'com.squareup.okhttp3:logging-interceptor:3.9.1'
   implementation 'com.google.code.gson:gson:2.8.0'
   

4. Add import com.keenmedia.keenowvpnsdk.VPNSDK; to main activity source file.

5. Initialize SDK in Activity OnCreate handler:

   VPNSDK.InitOVSCore(new VPNSDK.OVSNotifyCB() {
       @Override
       public void onNotify(String s) {
   
       }
   }, this);
   

4. iOS

Language recommended: Swift

1. Download library from Google Drive

2. Unpack downloaded archive

3. Create new application for iOS using XCode

4. Add VPNSDK.framework to Embedded Binaries section on General tab

5. Turn on Personal VPN capability on Capabilities tab

6. Import SDK in your main view controller:

   import VPNSDK
   

7. Implement OVSNotifyDelegate interface in the view controller class:

   func OVSNotifyCB(_ notify_code: OVS_NOTIFY_CODES, _ err_code: OVS_ERROR_CODES, _ data: String?) { }
   

8. Intialize SDK in viewDidLoad method of your main view:

   vpnsdk = VPNSDK()
   vpnsdk.InitOVSCore(self)
   

9. To call SDK methods there is a vpnsdk.CmdProc method

You can find example application here

4. Ubuntu Linux

1. Download library from Google Drive
2. Unpack downloaded archive

3. Library can be used in 2 ways:

   a. As a static library linked to the application

   b. As a separate process listening for commands on localhost

4. To use it as a static library it is necessary to link project towards lubkucore.a and add #include "CoreAPI.h" to the file where you are going to use SDK commands.

5. To use it as a separate process it is necessary to run ovscore binary as a daemon:

   ovscore -d

   It will listen for commands on the TCP port 6733. You can find the example of client application in ovsconsole.cpp

2. Generic interface

1. InitOVSCore

C Signature: int InitOVSCore(callback, ovpn_path, isIKEv2Mode=false)

Java signature: int InitOVSCore(OVSNotifyCB callback, Activity context)

Android usage example

OS X usage example

Where:

callback - instance of OVSNotifyCB interface context - application activity

{
  "code": integer
  "err": integer
  "data": { object }
}

Description

Intializes SDK with callback and sets necessary path to OpenVPN binary.

2. void FinalizeOVSCore()

Android usage example

OS X usage example

Description

Unloads SDK and finalizes all running threads.

3. void CmdProc(szCmdData)

Android usage example

OS X usage example

{
    "cmd": int,
    "data: { Command parameters }
}

Description

Asynchronously sends command to SDK. Command result will be returned by calling callback provided on initialization.

3. SDK Commands

1. Login

Code: OVS_CMD_LOGIN

Notification: OVS_NOTIFY_LOGIN

Possible errors: OVS_ERR_WEB_API, OVS_ERR_RESP_INVALID, OVS_ERR_LOGIN_FAILED

Login required: No

Android usage example

OS X usage example

{
    "username": "",
    "password": ""
}

 {
    "result": "success",
    "clientid": "2",
    "serviceid": null,
    "pid": null,
    "domain": null,
    "totalresults": 3,
    "startnumber": 0,
    "numreturned": 3,
    "products": {
      "product": [
        {
          "id": 78013,
          "clientid": 2,
          "orderid": 78065,
          "pid": 16,
          "regdate": "2018-07-19",
          "name": "24 Months",
          "translated_name": "24 Months",
          "groupname": "Keenow",
          "translated_groupname": "Keenow",
          "domain": "",
          "dedicatedip": "",
          "serverid": 0,
          "servername": "",
          "serverip": null,
          "serverhostname": null,
          "suspensionreason": "",
          "firstpaymentamount": "0.00",
          "recurringamount": "0.00",
          "paymentmethod": "amazonsimplepay",
          "paymentmethodname": "FREE",
          "billingcycle": "Biennially",
          "nextduedate": "2020-07-19",
          "status": "Active",
          "username": "some user name",
          "password": "some password",
          "subscriptionid": "",
          "promoid": 0,
          "overideautosuspend": 0,
          "overidesuspenduntil": "0000-00-00",
          "ns1": "",
          "ns2": "",
          "assignedips": "",
          "notes": "",
          "diskusage": 0,
          "disklimit": 0,
          "bwusage": 0,
          "bwlimit": 0,
          "lastupdate": "0000-00-00 00:00:00",
          "customfields": {
            "customfield": []
          },
          "configoptions": {
            "configoption": []
          }
        }
      ]
    },
    "debug": "on"
  }

{
    "nextduedate":"2020-07-19",
    "password":"",
    "status":"Active",
    "username":"",
    "name":"24 Months",
    "email":"",
    "debug":true,
    "billingcycle": "Monthly"
}

Description

Tries to login to management interface and retrieves registered products assosiated with given user.

2. Get servers list (Deprecated)

Code: OVS_CMD_GET_SERVLIST

Notification: OVS_NOTIFY_GET_SERVLIST

Possible errors: OVS_ERR_WEB_API

Login requiered: No

Android usage example

OS X usage example

{
    "premium": true | false
}

{
    "U.S. New York": [
      {
        "ip": "104.192.3.90"
      },
      {
        "tcp_ports": [
          "1194",
          "8080",
          "8181"
        ]
      },
      {
        "udp_ports": [
          "1194",
          "8080",
          "8181"
        ]
      },
      {
        "flag": "url/us.png"
      }

1. ip - server IP address
2. tcp_ports - available TCP ports
3. upd_ports - available UDP ports
4. flag - server flag url.

Description

Requests available VPN servers.

3. Get servers list by geolocation

Code: OVS_CMD_GET_SERVLIST_BYGEO

Notification: OVS_NOTIFY_GET_SERVLIST_BYGEO

Possible errors: OVS_ERR_WEB_API

Login requiered: No

Android usage example

OS X usage example

{
    "premium": true | false
}

[
    {
        "ip": "192.111.132.43",
        "name": "Canada Vancouver",
        "hostname": "canada-vancouver.keenvpn.me",
        "country": "CA",
        "cipher": [
            "BF-CBC",
            "AES-128-CBC",
            "AES-128-GCM",
            "AES-256-CBC",
            "AES-256-GCM"
        ],
        "cipher_tcp_ports": [
            "1194",
            "8080",
            "8181",
            "1299",
            "1199",
            "8989",
            "8289",
            "1399",
            "9989"
        ],
        "cipher_udp_ports": [
            "1194",
            "8080",
            "8181",
            "1299",
            "1199",
            "8989",
            "8289",
            "1399",
            "9989"
        ],
        "lz4": true,
        "lz4_ports": [
            "1149",
            "4600",
            "5500"
        ],
        "xor": true,
        "xor_ports": [
            "443",
            "80",
            "1499",
            "9919",
            "8332",
            "30303",
            "18080",
            "8081",
            "3333"
        ],
        "smart_dns_id": "14",
        "flag": "https:\/\/client-api.keenow.com\/serverlist\/flags\/new_res\/ca.png",
        "protocols": {
            "l2tp": true,
            "openvpn": true,
            "ikev2": true,
            "wg": true,
            "wg_pubkey": "SOME_WIREGUARD_PUBLIC_KEY"
        },
        "lat": "49.2366",
        "lon": "-122.8521",
        "distance": 10251.369694275
    }
]

Description

Requests available VPN servers and sorts them from nearest to farest based on end-user's IP address.

4. Get servers list by country

Code: OVS_CMD_GET_SERVLIST_BYCOUNTRY

Notification: OVS_NOTIFY_GET_SERVLIST_BYCOUNTRY

Possible errors: OVS_ERR_WEB_API

Login required: No

Android usage example

OS X usage example

{
    "country": "",
    "premium": true | false
}

[
    {
        "ip": "192.111.132.43",
        "name": "Canada Vancouver",
        "hostname": "canada-vancouver.keenvpn.me",
        "country": "CA",
        "cipher": [
            "BF-CBC",
            "AES-128-CBC",
            "AES-128-GCM",
            "AES-256-CBC",
            "AES-256-GCM"
        ],
        "cipher_tcp_ports": [
            "1194",
            "8080",
            "8181",
            "1299",
            "1199",
            "8989",
            "8289",
            "1399",
            "9989"
        ],
        "cipher_udp_ports": [
            "1194",
            "8080",
            "8181",
            "1299",
            "1199",
            "8989",
            "8289",
            "1399",
            "9989"
        ],
        "lz4": true,
        "lz4_ports": [
            "1149",
            "4600",
            "5500"
        ],
        "xor": true,
        "xor_ports": [
            "443",
            "80",
            "1499",
            "9919",
            "8332",
            "30303",
            "18080",
            "8081",
            "3333"
        ],
        "smart_dns_id": "14",
        "flag": "https:\/\/client-api.keenow.com\/serverlist\/flags\/new_res\/ca.png",
        "protocols": {
            "l2tp": true,
            "openvpn": true,
            "ikev2": true
        },
        "lat": "49.2366",
        "lon": "-122.8521",
        "distance": 10251.369694275
    }
]

Description

Requests available VPN servers and sorts them from nearest to farest based on given country.

5 Check internet connection

Code: OVS_CMD_CHECK_INTERNET

Notification: OVS_NOTIFY_CHECK_INTERNET

Possible errors: OVS_ERR_INTERNET_DISCONNECTED

Login required: No

Android usage example

OS X usage example

Description

Attempts to make connection to API server. If connection failed, returns OVS_ERR_INTERNET_DISCONNECTED error.

6. Get device ID

Code: OVS_CMD_GET_DEVICEID

Notification: OVS_NOTIFY_GET_DEVICEID

Possible errors:

Login required: No

Android usage example

OS X usage example

{
    "device_id" : ""
}

Description

Returns device identifier where application is being run.

7. Check open port

Code: OVS_CMD_CHECK_PORT

Notification: OVS_NOTIFY_CHECK_PORT

Possible errors: OVS_ERR_PORT_CLOSED

Login required: No

Android usage example

OS X usage example

{
    "ip_addr": "1.1.1.1",
     "proto": "tcp",
    "port": 1194
}

Description

Attempts to make connection to specified host and port. If connection failed, returns OVS_ERR_PORT_CLOSED error.

8. Set API domain

Code: OVS_CMD_SET_API_DOMAIN

Notification: OVS_NOTIFY_SET_API_DOMAIN

Possible errors: OVS_ERR_MISSING_PARAMS

Login required: No

Android usage example

OS X usage example

{
    "api_domain": "test_domain.com"
}

Description

Initialises API domain. Please ask VPNWholesaler.com for your own dedicated API domain.

9. Set API key

Code: OVS_CMD_SET_API_KEY

Notification: OVS_NOTIFY_SET_API_KEY

Possible errors: OVS_ERR_MISSING_PARAMS

Login required: No

Android usage example

OS X usage example

{
     "api_key": "test_api_key"
}

Description

Initializes API key required for new user creation. Please ask VPNWholesaler.com for your own dedicated API key.

10. Get ping

Code: OVS_CMD_GET_PING_RESULT

Notification: OVS_NOTIFY_GET_PING_RESULT

Possible errors: OVS_ERR_MISSING_PARAMS, OVS_ERR_WEB_API

Login required: No

Android usage example

OS X usage example

{
     "ip_addr": "1.1.1.1"
}

 {
    "ip_addr": "45.32.158.20",
    "time": 341
 }

Description

Attempts to check connection to given VPN server and, if connection could be established, measures ping time.

11. Check AES support

Code: OVS_CMD_CHECK_AES

Notification: OVS_NOTIFY_CHECK_AES

Possible errors:

Login required: No

Android usage example

OS X usage example

{
    "AES_Support" : true|false
}

Description

Checks if device has support of AES encryption

12. Set encryption

Code: OVS_CMD_SET_ENCRYPTION

Notification: OVS_NOTIFY_SET_ENCRYPTION

Possible errors: OVS_ERR_MISSING_PARAMS

Login required: No

Android usage example

OS X usage example

{
     "cipher": "CBC"
}

Description

Sets cipher for VPN connection

13. Enable or disable IO counter

Code: OVS_CMD_SET_IOCOUNT

Notification: OVS_NOTIFY_SET_IOCOUNT

Possible errors: OVS_ERR_MISSING_PARAMS

Login required: No

Android usage example

OS X usage example

{
     "status": true|false
}

Description

Enables of disables IO counter. When IO counter is enabled, SDK will send notifications with code OVS_NOTIFY_VPN_IOCOUNT with data parameter of the following structure:

{
    "data_in": 0,
    "speed_in": 0,
    "data_out": 0,
    "speed_out": 0
}

Where:

data_in - downloaded data amount

speed_in - current download speed

data_out - uploaded data amount

speed_out - current upload speed

14. Get current profile

Code: OVS_CMD_GET_CURRENT_PROFILE

Notification: OVS_NOTIFY_GET_CURRENT_PROFILE

Possible errors: OVS_ERR_VPN_DISCONNECTED

Login required: Yes

Android usage example

OS X usage example

{
    "server_ip": "45.32.158.20",
    "protocol": "tcp",
    "server_port": 1194
}

Description

Returns current VPN connection parameters like server, protocol and port. VPN should be connected.

15. Get account type

Code: OVS_CMD_GET_ACCOUNT_TYPE

Notification: OVS_NOTIFY_GET_ACCOUNT_TYPE

Possible errors:

Login required: Yes

Android usage example

OS X usage example

{
    "account_type": "24 Months"
}

Description

Returns current user's plan desciption

16. Get account credentials

Code: OVS_CMD_GET_ACCOUNT_CREDENTIAL

Notification: OVS_NOTIFY_GET_ACCOUNT_CREDENTIAL

Possible errors:

Login required: Yes

Android usage example

OS X usage example

{
    "username": "",
    "password": ""
}

Description

Returns current user's credentials used to connect to VPN server

17. Get account expiration date

Code: OVS_CMD_GET_ACCOUNT_EXP_DATE

Notification: OVS_NOTIFY_GET_ACCOUNT_EXP_DATE

Possible errors:

Login required: Yes

Android usage example

OS X usage example

{
    "exp_date": "2020-12-31",
}

Description

Returns current user's account expiration date

18. Set XOR mode

Code: OVS_CMD_ENABLE_XOR

Notification: OVS_NOTIFY_ENABLE_XOR

Possible errors: OVS_ERR_MISSING_PARAMS

Login required: No

Android usage example

OS X usage example

{
     "status": true|false
}

Description

Enable or disable VPN traffic obfuscation.

19. Set logger mode

Code: OVS_CMD_SET_LOGGING

Notification: OVS_NOTIFY_SET_LOGGING

Possible errors: OVS_ERR_MISSING_PARAMS

Login required: No

Android usage example

OS X usage example

{
     "status": true | false
}

Description

Enable or disable log file creation. Logging is disabled by default.

20. Start VPN connection

Code: OVS_CMD_CONNECT

Notification: OVS_NOTIFY_VPN_CONNECTING,OVS_NOTIFY_VPN_CONNECTED, OVS_NOTIFY_VPN_DISCONNECTED, OVS_NOTIFY_VPN_CONNECT_FAILED, OVS_NOTIFY_VPN_ABNOMARLY_DISCONNECTED

Possible errors:

Login required: Yes

Android usage example

OS X usage example

Windows usage example

{
    "ip_addr": "45.32.158.20",
    "proto": "tcp",
    "port": 1194,
    "ipv6_leak": 1,
    "kill_switch": 1
}

{
    "server_name": "server.com",
    "ipv6_leak": 1,
    "kill_switch": 1
}

{
    "ip_addr": "45.32.158.20",
    "wg_pubkey": "",
    "ipv6_leak": 1,
    "kill_switch": 1
}

{
    "ip_addr": "45.32.158.20",
    "ipv6_leak": 1,
    "kill_switch": 1
}

Description

Start VPN connection to given server. While establishing connection SDK will notify application with the following notification when connection status is changed:

OVS_NOTIFY_VPN_CONNECTING - connection is being established

OVS_NOTIFY_VPN_CONNECTED - connection was established sucessfully

OVS_NOTIFY_VPN_DISCONNECTED - VPN was disconnected

OVS_NOTIFY_VPN_CONNECT_FAILED - VPN failed to connect

OVS_NOTIFY_VPN_ABNOMARLY_DISCONNECTED - connection was dropped

Each notification has data property set to null

When using IKEv2 and WireGuard connections method SET_BINARY_PATH should be called prior to starting connection

21. Stop VPN connection

Code: OVS_CMD_DISCONNECT

Notification: OVS_NOTIFY_VPN_DISCONNECTED

Possible errors:

Login required: Yes

Android usage example

OS X usage example

Description

Stops established VPN connection. When VPN is disconnected SDK sends OVS_NOTIFY_VPN_DISCONNECTED notification

This notification has data property set to null

22. Get VPN status

Code: OVS_CMD_GET_STATUS

Notification: OVS_NOTIFY_GET_STATUS

Possible errors:

Login required: Yes

Android usage example

OS X usage example

{
    "VPN_Status": 1
}

Description

Requests current VPN connection status.

23. Add client

Code: OVS_CMD_ADD_CLIENT

Notification: OVS_NOTIFY_ADD_CLIENT

Possible errors: OVS_ERR_MISSING_PARAMS, OVS_ERR_WEB_API, OVS_ERR_FAILED_ADD_CLIENT

Login required: No

API Key required

Android usage example

OS X usage example

{
       "email": "[email protected]",
        "password": "123456",
        "countrycode": "US",
        "type": ""
}

Description

Registers client on server. Requires valid API key to be set.

24. Remove client

Code: OVS_CMD_CLOSE_CLIENT

Notification: OVS_NOTIFY_CLOSE_CLIENT

Possible errors: OVS_ERR_MISSING_PARAMS, OVS_ERR_WEB_API

Login required: No

API Key required

Android usage example

OS X usage example

{
       "email": "[email protected]",
}

Description

Disables client's account on server. Requires valid API key to be set.

25. Reset password

Code: OVS_CMD_RESET_PASSWORD

Notification: OVS_NOTIFY_RESET_PASSWORD

Possible errors: OVS_ERR_MISSING_PARAMS, OVS_ERR_WEB_API

Login required: No

API Key required

Android usage example

OS X usage example

{
       "email": "[email protected]",
}

Description

Initiates user password reset. If successful, the end-user shall recieve an email with new password.

26. Enable IKEv2 VPN connection mode (Deprecated)

Code: OVS_CMD_ENABLE_IKEV2

Notification: OVS_NOTIFY_ENABLE_IKEV2

Possible errors:

Login required: Yes

Windows usage example

OS X usage example

{
    "status": true | false
}

Description

Enable IKEv2 VPN connection mode. When mode changed SDK sends OVS_NOTIFY_ENABLE_IKEV2 notification

This notification has data property set to null

27. Start IKEv2 VPN connection (Deprecated)

Code: OVS_CMD_CONNECT_IKEV2

Notification: OVS_NOTIFY_VPN_CONNECTING,OVS_NOTIFY_VPN_CONNECTED, OVS_NOTIFY_VPN_DISCONNECTED, OVS_NOTIFY_VPN_CONNECT_FAILED, OVS_NOTIFY_VPN_ABNOMARLY_DISCONNECTED

Possible errors:

Login required: Yes

Windows usage example

Android usage example

OS X usage example

{
    "ip_addr": "45.32.158.20",
    "server_name": "russia-st-petersburg.keenvpn.me",
    "proto": "tcp",
    "port": 1194,
    "ipv6_leak": 1,
    "kill_switch": 1,
    "primary":"62.210.122.43",
    "secondary":"157.55.83.218"
}

Description

Start VPN connection using IKEv2 protocol to given server. While establishing connection SDK will notify application with the following notification when connection status is changed:

OVS_NOTIFY_VPN_CONNECTING - connection is being established

OVS_NOTIFY_VPN_CONNECTED - connection was established sucessfully

OVS_NOTIFY_VPN_DISCONNECTED - VPN was disconnected

OVS_NOTIFY_VPN_CONNECT_FAILED - VPN failed to connect

OVS_NOTIFY_VPN_ABNOMARLY_DISCONNECTED - connection was dropped

Each notification has data property set to null

Here is the guide to create ipsec command

28. Stop IKEv2 VPN connection (Deprecated)

Code: OVS_CMD_DISCONNECT_IKEV2

Notification: OVS_NOTIFY_VPN_DISCONNECTED

Possible errors:

Login required: Yes

Windows usage example

Android usage example

OS X usage example

Description

Stops established IKEv2 VPN connection. When VPN is disconnected SDK sends OVS_NOTIFY_VPN_DISCONNECTED notification

This notification has data property set to null

29. Get VPN status (Deprecated)

Code: OVS_CMD_GET_STATUS_IKEV2

Notification: OVS_NOTIFY_GET_STATUS

Possible errors:

Login required: Yes

Windows usage example

{
    "VPN_Status": 0
}

Description

Requests current VPN connection status.

30. Check TAP adapter status

Code: OVS_CMD_CHECK_TAP_ADAPTER

Notification: OVS_NOTIFY_CHECK_TAP_ADAPTER

Possible errors:

Login required: Yes

Windows usage example

Description

Requests current TAP adapter status.

31. Log out

Code: OVS_CMD_LOGOUT

Notification: OVS_NOTIFY_LOGOUT

Possible errors:

Login required: Yes

Windows usage example

OS X usage example

Description

Requests current TAP adapter status.

32. Switch VPN server

Code: OVS_CMD_SWITCH_VPN_SERVER

Notification: OVS_NOTIFY_SWITCH_VPN_SERVER

Possible errors:

Login required: Yes

Windows usage example

OS X usage example

{
    "ip_addr": "45.32.158.20",
    "server_name": "russia-st-petersburg.keenvpn.me"
}

Description

Switch VPN server

33. Disable IPv6

Code: OVS_CMD_DISABLE_IPV6

Notification: OVS_NOTIFY_DISABLE_IPV6

Possible errors:

Login required: Yes

Windows usage example

Description

Disable IPv6

34. Set Binary Path

Code: OVS_CMD_SET_BINARY_PATH

Notification: OVS_NOTIFY_SET_BINARY_PATH

Possible errors:

Login required: No

Windows usage example

OS X usage example

{
    "path": "/folder/with/binaries"
}

Description

Set path where SDK should search StrongSwan and WireGuard binaries.

Folder with binaries should have the following structure:

/folder/with/binaries
    /wireguard
        /wg
        /wg-quick3
        /wg-quick5
        /wireguard-go
    /ipsec
        /sbin
            /ipsec
            /swanctl

35. Change plan

Code: OVS_CMD_CHANGE_PLAN

Notification: OVS_NOTIFY_CHANGE_PLAN

Possible errors: OVS_ERR_MISSING_PARAMS, OVS_ERR_WEB_API

Login required: No

API Key required

Android usage example

{
       "email": "[email protected]",
       "type": "1np"
}

Description

Changes user plan on server. Requires valid API key to be set. type parameter depends on particular implementation, but generally can be a string representing number of months. In case of non-premiuns plan 'np' postfix is expected.

36. set VPN Type

Code: OVS_CMD_SET_VPN_TYPE

Notification: OVS_NOTIFY_SET_VPN_TYPE

Possible errors:

Login required: Yes

Android usage example

OS X usage example

Windows usage example

{
    "vpn_type": 0
}

Description

Change VPN Protocol