Generate VPN Account

Estimated reading: 3 minutes

Generate

Use this API to create a VPN account by supplying a UUID as a mandatory parameter. If the UUID is found in the system, the details of the existing VPN account will be returned; otherwise, a new VPN account will be created and returned.

It returns a JSON object with the VPN username, password, and expiry date.

URL: <base url>/vam/v2/generate
Request Method: POST

Payload

Key	Type	Pass in	Description
`X-AccessToken`*	String	Header	`accessToken` retrieved from Get Access Token endpoint
`uuid`*	String	Body	A universally unique identifier can be any string, email, or unique word.
`period`	String	Body	Account period. The maximum is 3700.
`preferences`	JSON	Body	A structured JSON to specify allowed options such as multi-login limit and locations for the VPN account. Sample JSON: {“multi_login”:5,”session_limit”:50,”country”:[1,2,3],”city”:[1,2,3],”protocol”:[1,2,3]}
`preferences_format`	JSON	Body	Format of the preferences and its value should always be keys
`isDedicated`	Boolean	Body	A boolean (True or False) that VPN account will be dedicated or shared Default: false
`dedicatedCountry`	String	Body	If `isDedicated` is true, this parameter is mandatory and should contain the country ISO code, indicating that this VPN account will have a dedicated IP in that country. Supported countries include: US, UK, CA, DE, AU, HK, NL, SG , NZ and MT.
`oneLoginScheme`	Boolean	Body	This boolean (True or False) indicate that either you’ll provide username and password or it should be auto generate. Default is ‘False’
`vpnUsername`	String	Body	If `oneLoginScheme` is true, then the VPN username is mandatory and must not exceed 20 characters.
`vpnPassword`	String	Body	If `oneLoginScheme` is true then VPN password is mandatory to provide. Length: Minimum 12, maximum 32 characters. Complexity: Must contain at least one uppercase letter, one lowercase letter, one number, and one special character (!@#$%^&,.:{}). Character Restriction:* Avoid using non-ASCII characters like (£, 你好).

(*) Required Parameter

Response

Key	Type	Description
`header`	JSON	JSON object that describes return code and message
`body`	JSON	JSON object that return username and password. Dedicated IP and dedicated host will also return if account would be dedicated

Possible API error codes

Code	Message	Description
`11001`	The vpnUsername field is required when one login scheme is 1	The vpnUsername field must be provided when the login scheme is set to 1.
`11001`	Period must be a number between 1 and 10950	The provided period is invalid and must be between 1 and 10,950.
`11001`	The provided uuid already exists.	The UUID provided already exists in the system.
`60001`	Account containing this uuid is expired	The account associated with this UUID has expired.
`60002`	Account containing this uuid is disabled	The account associated with this UUID is disabled.
`60003`	Accounts can not be exceed subscribed no of accounts	The number of accounts has exceeded the reseller’s subscription limit.
`100028`	This username is not available. Please try again with different username	The username is already in use. Please choose a different one.

Sample Response

{
  "header": {
    "response_code": 1,
    "message": "VPN account has been created successfully"
  },
  "body": {
    "vpnUsername": "xxxxxxxx",
    "vpnPassword": "xxxxxxxx",
    "expiryDate": "xxxxxxxx",
  }

Generate VPN Account

Generate

Payload

Response

Possible API error codes

Sample Response

Generate VPN Account

On This Page