VPN User

Remote-access (client) VPN users for a network.

Resource base path: /restapi/vpnuser

Method	Path	Description
POST	/restapi/vpnuser/addVpnUser	Add VPN User
GET	/restapi/vpnuser/vpnUserlist	VPN User List
DELETE	/restapi/vpnuser/deleteVpnUser	Delete VPN User

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Add VPN User

Add VPN User.

POST /restapi/vpnuser/addVpnUser

Request body

Field	Type	Required	Description
password	string	No	Password.
username	string	No	User name.

{
  "password": "string",
  "username": "example-name"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/vpnuser/addVpnUser" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "string",
  "username": "example-name"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "listVpnUserResponse": [
    {
      "domainUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "userName": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ],
  "count": 1
}

---

VPN User List

VPN User List.

GET /restapi/vpnuser/vpnUserlist

Parameters

Parameter	In	Type	Required	Description
uuid	query	string	No	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/vpnuser/vpnUserlist" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "listVpnUserResponse": [
    {
      "domainUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "userName": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ],
  "count": 1
}

---

Delete VPN User

Delete VPN User.

DELETE /restapi/vpnuser/deleteVpnUser

Parameters

Parameter	In	Type	Required	Description
userName	query	string	✅ Yes	User name.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/vpnuser/deleteVpnUser?userName=VALUE" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

true