Skip to main content
GET
/
vpn
/
{vid}
Get VPN ID
curl --request GET \
  --url https://app.onefirewall.com/api/v1/vpn/{vid} \
  --header 'Authorization: <api-key>'
{
  "vid": "OFA-VID-LIC-XXXXXX",
  "account_name": "Test",
  "notes": "",
  "ts": 1720917876,
  "user": {
    "guid": "OFA-GUID-2091-4193-9813",
    "name": "Name",
    "surname": "Surname",
    "username": "[email protected]",
    "role": 0,
    "unsuccessful_login": 0,
    "member_of": {
      "gid": "OFA-GID-XXXXXXX",
      "name": "OneFirewall Alliance LTD",
      "trust": 0.85,
      "delay": "0",
      "credit_tokens": 20003000,
      "debit_tokens": 2597036,
      "is_public": 0
    }
  },
  "mgid": "OFA-GID-XXXXXXXXX",
  "exist": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.onefirewall.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authorization Token

Path Parameters

​
vid
string
required

VPN ID (Starts with OFA-VID-LIC prefix)

Response

200 - application/json

The response is of type string.