OperatorAPI vtun:list

newadmapi (Operator API) function. Available to: Operator, SuperRoot.

Description

Lists customer VPN tunnels. Tenant-scoped. The VPN password is credential-class and is published nowhere; `status` is the live tunnel state (1 up, 0 down), set by the monitor and never writable - changing it emails the customer. Paginated. Sorting and searching are restricted to the declared fields; anything else is rejected and named. Read audience is provisional pending operator confirmation.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=vtun:list

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

None beyond the API key and func=vtun:list.

Example

https://host:port/newadm?func=vtun:list

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape (n = number, s = string, ? = present only when set):

{
  "ok":true,
  "data":{
    "rows":[
      {
        "id":n,
        "accountcode":s,
        "host":s,
        "dev":s,
        "ip_svr":s,
        "ip_cl":s,
        "status":n
      }
    ],
    "page":n,
    "pagesize":n,
    "fields":[
      s
    ],
    "available":[
      s
    ],
    "order":s,
    "dir":s,
    "filterby":s?,
    "filter":s?
  }
}

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

---

Back to OperatorAPI