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

Key	Type	Pass in	Description
`X-AccessToken`*	String	Header	`accessToken` retrieved from Get Access Token endpoint
`vpnUsername`*	String	Body	VPN Username

(*) Required Parameter

Response

Key	Type	Description
`header`	JSON	JSON object that describes return code and message
`body`	JSON	A JSON object that returns the username of the deleted account.

Possible API error codes

Code	Message	Description
`1301`	There is some problem in deleting vpn account	An error occurred while attempting to delete the VPN account.
`11001`	The provided username is not valid for this reseller	The 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"
  }
}

Delete Account

Delete

Payload

Response

Possible API error codes

Sample Response

Delete Account

On This Page