Get Started

Enable Account

Estimated reading: 1 minute

Enabling a VPN account via API is an essential feature for managing VPN user access dynamically. This functionality allows administrators to activate or enable VPN accounts programmatically, ensuring users can access VPN resources as needed. This article provides a concise technical overview of how to enable a VPN account through API calls.

Enable

Use this API to enable a VPN user for further use.

Returns a JSON object that contains the VPN username and updated status.

  • URL: <base url>/vam/v2/enable
  • Request Method: PUT

Payload

KeyTypePass inDescription
X-AccessToken*StringHeaderaccessToken retrieved from Get Access Token endpoint
vpnUsername*StringBodyVPN Username

Response

KeyTypeDescription
headerJSONJSON object that describes return code and message
bodyJSONJSON object that return username and user updated status

Possible API error codes

CodeMessageDescription
1401There is some problem in enabling vpn accountAn error occurred while attempting to enable the VPN account.
11001The provided username is not valid for this resellerThe provided username is not recognized as valid for the associated reseller.

Sample Response

{
  "header": {
    "response_code": 1,
    "message": "VPN account has been enabled successfully"
  },
  "body": {
    "vpnUsername": "xxxxx",
    "statusUpdated": "Enable"
  }
}
Share this Doc

Enable Account

Or copy link

On This Page