uuid<\/code>*<\/td>String<\/td> Body<\/td> A universally unique identifier can be any string, email, or unique word.<\/td><\/tr> period<\/code><\/td>String<\/td> Body<\/td> Account period. The maximum is 3700.<\/td><\/tr> preferences<\/code><\/td>JSON<\/td> Body<\/td> A structured JSON to specify allowed options such as multi-login limit and locations for the VPN account. preferences_format<\/code><\/td> JSON<\/td> Body <\/td> Format of the preferences and its value should always be key<\/strong><\/td><\/tr>isDedicated<\/code><\/td>Boolean<\/td> Body<\/td> A boolean (True or False) that VPN account will be dedicated or shared dedicatedCountry<\/code><\/td>String<\/td> Body<\/td> If\u00a0isDedicated<\/code>\u00a0is 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, GB, CA, DE,\u00a0AU,\u00a0HK, NL, SG , NZ\u00a0and\u00a0MT.<\/td><\/tr>oneLoginScheme<\/code><\/td>Boolean<\/td> Body<\/td> This boolean (True or False) indicate that either you\u2019ll provide username and password or it should be auto generate. Default is \u2018False\u2019<\/td><\/tr> vpnUsername<\/code><\/td>String<\/td> Body<\/td> If oneLoginScheme<\/code> is true, then the VPN username is mandatory and must not exceed 20 characters.<\/td><\/tr>vpnPassword<\/code><\/td>String<\/td> Body<\/td> If oneLoginScheme<\/code> is true then VPN password is mandatory to provide.Length:<\/strong> Minimum 12, maximum 32 characters.Complexity:<\/strong> Must contain at least one uppercase letter, one lowercase letter, one number, and one special character (!@#$%^&*,.:{}).Character Restriction:<\/strong> Avoid using non-ASCII characters like (\u00a3, \u4f60\u597d).<\/td><\/tr>subscriptionType<\/code><\/td>String<\/td> Body<\/td> Account subscription type (trial<\/strong>, paid<\/strong> and freemium<\/strong>) by default is paid<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n(*) Required Parameter<\/p>\n\n\n\n
Response<\/h3>\n\n\n\nKey<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>header<\/code><\/td>A JSON object that details the return code and message.<\/td><\/tr> body<\/code><\/td>A JSON object containing the VPN username, password, and expiry date. If the account is dedicated, it will also include the dedicated IP and dedicated host.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nPossible API error codes<\/h3>\n\n\n\nCode<\/strong><\/td>Message<\/strong><\/td>Description<\/strong><\/td><\/tr>11001<\/code><\/td>The provided uuid already exists.<\/td> The UUID provided already exists in the system.<\/td><\/tr> 11001<\/code><\/td>The vpnUsername field is required when one login scheme is 1<\/td> The vpnUsername field must be provided when the login scheme is set to 1.<\/td><\/tr> 11001<\/code><\/td>Period must be a number between 1 and 10950<\/td> The provided period is invalid and must be between 1 and 10,950.<\/td><\/tr> 60003<\/code><\/td>Accounts can not be exceed subscribed no of accounts<\/td> The number of accounts has exceeded the reseller’s subscription limit.<\/td><\/tr> 60004<\/code><\/td>Couldn’t Verify UUID<\/td> The UUID could not be verified.<\/td><\/tr> 100028<\/code><\/td>This username is not available. Please try again with different username<\/td> The username is already in use. Please choose a different one.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nSample Response<\/h3>\n\n\n\n{\n "header": {\n "response_code": 1,\n "message": "VPN account has been created successfully"\n },\n "body": {\n "vpnUsername": "xxxxxxxx",\n "vpnPassword": "xxxxxxxx",\n "expiryDate": "xxxxxxxx",\n }\n}<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"Creating VPN accounts programmatically through APIs allows for automated and scalable user management. This process is crucial for integrating VPN services into applications, providing users with secure and efficient access to VPN networks. This article provides a technical overview of how to implement VPN account creation via API. Create Use this API to create a […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":10017,"menu_order":5,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"acf":[],"_links":{"self":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10035"}],"collection":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/comments?post=10035"}],"version-history":[{"count":55,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10035\/revisions"}],"predecessor-version":[{"id":11135,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10035\/revisions\/11135"}],"up":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10017"}],"wp:attachment":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/media?parent=10035"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/doc_tag?post=10035"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}