VPN

List VPN connections

Changed on

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

Request

Response

Customer connection records and the configured connection allowance

successtrue required
current_connectionsinteger required

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

max_allowedinteger required

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

Example response

{
  "connections": [
    {
      "device_info": "iPhone 16",
      "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"
    }
  ]
}

Changes