Skip to main content
GET
Get VPN connection stats for current user

Authorizations

Authorization
string
header
required

Personal Access Token (PAT) passed in the Authorization header (e.g., Bearer <pat>) for authenticated API requests. PATs are generated via /auth/generate-pat after authenticating through the magic link flow.

Query Parameters

org_id
string
required
Example:

"60c72b2f5f1b2c001c8e4b1a"

Response

The caller's connection state. When the user is not connected, or the VPN host cannot be reached, the body is {"connected": false} and no other field is present. Every field except connected is returned only when connected is true.

connected
boolean
required
Example:

true

privateIP
string

Address assigned to the client inside the tunnel

Example:

"10.8.0.6"

publicIP
string

Public address of the VPN host

Example:

"203.0.113.1"

bytesReceived
integer<int64>
Example:

1048576

bytesSent
integer<int64>
Example:

524288

connectedTime
string

Session duration formatted as HH:MM:SS

Example:

"02:15:00"