VPN Account Management

Delete Account

Estimated reading: 1 minute

Deleting a VPN account via API is an essential feature for managing user access and maintaining control over VPN resources. This functionality allows administrators to programmatically remove VPN accounts, which is crucial for deactivating unused or unnecessary accounts and ensuring that access is properly managed. This article provides a technical overview of how to implement VPN account deletion through API calls.

Delete

Use this API to delete a VPN Account.

Returns JSON object containing the username of the deleted account.

  • URL: <base url>/vam/v2/delete
  • Request Method: DELETE

Payload

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

Response

KeyTypeDescription
headerJSONJSON object that describes return code and message
bodyJSONA JSON object that returns the username of the deleted account.

Possible API error codes

CodeMessageDescription
1301There is some problem in deleting vpn accountAn error occurred while attempting to delete 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 deleted successfully"
  },
  "body": {
    "deletedVpnUsername": "xxxxx"
  }
}
Share this Doc

Delete Account

Or copy link

On This Page