List VPN connections

curl --request GET \
  --url https://demo.onlinebillingform.com/api/v2/vpn/connections/list \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://demo.onlinebillingform.com/api/v2/vpn/connections/list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://demo.onlinebillingform.com/api/v2/vpn/connections/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo.onlinebillingform.com/api/v2/vpn/connections/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.onlinebillingform.com/api/v2/vpn/connections/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://demo.onlinebillingform.com/api/v2/vpn/connections/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "connections": [
    {
      "id": 21,
      "device_info": "MacBook Pro",
      "server_id": 10,
      "server_name": "UK 01",
      "vpn_type": "wireguard",
      "connected_date": null,
      "connected_time": null,
      "created_at": "2026-10-25T12:35:00+00:00"
    },
    {
      "id": 20,
      "device_info": "iPhone 16",
      "server_id": 10,
      "server_name": "UK 01",
      "vpn_type": "wireguard",
      "connected_date": "2026-10-25",
      "connected_time": "12:34:56",
      "created_at": "2026-10-25T12:34:00+00:00"
    }
  ],
  "current_connections": 2,
  "max_allowed": 5
}

VPN

List VPN connections

Returns the authenticated account’s VPN connections. Customer API keys are supported; staff keys are denied. The bearer token determines the account, and id or customer_id query parameters cannot select another customer. No query parameters or request body are required. Results are not paginated and include pending reservations because they consume connection slots. Connection date and time record profile provisioning, not live tunnel activity. Compare each id with the connection_id saved from POST /vpn/connection/get to flag the current device. To disconnect another connection, send its id as connection_id to POST /vpn/disconnect; ownership checks still apply. VPN profile contents and server credentials are excluded.

GET

vpn

connections

list

List VPN connections

curl --request GET \
  --url https://demo.onlinebillingform.com/api/v2/vpn/connections/list \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://demo.onlinebillingform.com/api/v2/vpn/connections/list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://demo.onlinebillingform.com/api/v2/vpn/connections/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo.onlinebillingform.com/api/v2/vpn/connections/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.onlinebillingform.com/api/v2/vpn/connections/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://demo.onlinebillingform.com/api/v2/vpn/connections/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "connections": [
    {
      "id": 21,
      "device_info": "MacBook Pro",
      "server_id": 10,
      "server_name": "UK 01",
      "vpn_type": "wireguard",
      "connected_date": null,
      "connected_time": null,
      "created_at": "2026-10-25T12:35:00+00:00"
    },
    {
      "id": 20,
      "device_info": "iPhone 16",
      "server_id": 10,
      "server_name": "UK 01",
      "vpn_type": "wireguard",
      "connected_date": "2026-10-25",
      "connected_time": "12:34:56",
      "created_at": "2026-10-25T12:34:00+00:00"
    }
  ],
  "current_connections": 2,
  "max_allowed": 5
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer <live_api_key>.

Response

Customer connection records and the configured connection allowance

success

boolean

required

connections

object[]

required

All connection records belonging to the authenticated account, including pending reservations, ordered by descending connection ID. Empty when the account has no connections.

Show child attributes

current_connections

integer

required

Number of returned connection records, including pending reservations that consume connection slots.

Required range: x >= 0

max_allowed

integer

required

Tenant-wide per-customer connection limit. Returns 0 when the global setting is missing or resolves to a non-positive value.

Required range: x >= 0

Getting Started

Developer Hub

Webhooks

Endpoints

List VPN connections

Authorizations

Response