Disable Account

Estimated reading: 2 minutes

Disabling a VPN account via API is a critical functionality for managing user access and maintaining control over VPN resources. This feature allows administrators to deactivate or disable VPN accounts programmatically, ensuring that users can no longer access the VPN service when needed. This article provides a technical overview of how to implement VPN account disabling through API calls.

Disable

Use this API to disable VPN user for further use.

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

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

Payload

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

Response

Key	Type	Description
`header`	JSON	JSON object that describes return code and message
`body`	JSON	JSON object that return username and user updated status

Possible API error codes

Code	Message	Description
`1501`	There is some problem in disabling vpn account	An error occurred while attempting to disable the VPN account.
`11001`	vpnUsername is required	The vpnUsername field is required but was not provided.
`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 disabled successfully"
  },
  "body": {
    "vpnUsername": "xxxxx",
    "statusUpdated": "Disable"
  }
}