Developer Tools

WorldVPN API

Integrate your applications with WorldVPN's powerful API and leverage all of our top features. Manage VPN services under your own brand with simple RESTful endpoints.

Documentation

API Methods & Integration

All endpoints use https://www.worldvpn.net/api/ as base URL

Authentication

All API requests must authenticate by submitting your reseller username and reseller password as form-data parameters. Keep your credentials secure.

Sandbox Environment

Safely test your integration by sending mode="test". Sandbox requests return realistic success responses without billing your balance.

JSON Responses

All API responses are returned as content-type application/json with appropriate HTTP status codes for robust client handling.

Create VPN

POST

Creates a VPN account automatically — no usernames or passwords required. Specify the subscription period in months.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/addVPN \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="some username" \
  -F vpnPassword="some password" \
  -F period="1" \
  -F mode="test"

Expected JSON Response

{ "action": "createVPN", "result": "success", "vpnUsername": "sampleUsername", "vpnPassword": "samplePassword" }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
vpnPassword string Required
period integer Required
mode string Optional

Renew VPN

POST

Renew an existing VPN account by providing the username and the number of additional months.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/renewVPN \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="Your VPN Username" \
  -F period="1" \
  -F mode="test"

Expected JSON Response

{ "action": "renewVPN", "result": "success" }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
period integer Required
mode string Optional

Delete VPN

POST

Delete a VPN account by providing the VPN username.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/deleteVPN \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="Your VPN Username" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "vpnUsername": "sampleUsername", "vpnPassword": "samplePassword" }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
mode string Optional

Change VPN Password

POST

Update the password of a VPN account. Provide the username and your new password.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/changePassword \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="Your VPN Username" \
  -F vpnPassword="New Password" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "action": "changePassword" }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
vpnPassword string Required
mode string Optional

Take A Trial

POST

Create a 24-hour free VPN trial for a client by providing their email address.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/getTrial \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F email="Client Email" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "vpnUsername": "sampleUsername", "vpnPassword": "samplePassword" }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
email string Required
mode string Optional

List Servers

POST

Retrieve all WorldVPN server locations and their details.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/listServers \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F mode="test"

Expected JSON Response

{ "action": "getServers", "result": "success", "servers": [ [43, "Australia S1", "103.73.65.209"], [89, "Australia S2", "103.73.64.159"], [15, "Germany S1", "116.203.253.222"] ] }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
mode string Optional

Show Credit

POST

Check your reseller account credit balance.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/getCredit \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "credit": 99 }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
mode string Optional

Get Reseller VPN Accounts

POST

List all VPN accounts under your reseller account.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/getAccounts \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "accounts": [ [1, "demotestingvpn", "2026-07-19"] ] }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
mode string Optional

Check VPN Credentials

POST

Verify VPN login credentials — check whether a username and password combination is valid.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/checkAuth \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="some username" \
  -F vpnPassword="some password" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "vpnUsername": "sampleUsername", "vpnPassword": "samplePassword" }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
vpnPassword string Required
mode string Optional
WireGuard API

WireGuard Endpoints

Manage WireGuard peers and configurations programmatically

Add WireGuard Peer

POST

Creates a new WireGuard configuration for a VPN user on a specific server. Reseller accounts support up to **3 active WireGuard configurations** simultaneously. Returns the config ID, client IP, and server details.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/addWireGuardPeer \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="VPN Username" \
  -F serverId="1" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "wireguardId": "123", "clientIp": "10.0.0.2/32", "dns": "1.1.1.1, 8.8.8.8", "server": { "name": "US-NewYork-1", "publicKey": "wgServerPublicKeyBase64..." } }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
serverId integer Required
mode string Optional

Get WireGuard Config

POST

Retrieve WireGuard configuration(s) for a VPN user. Returns full config content (plaintext + Base64) ready for download or QR code generation.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/getWireGuardConfig \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="VPN Username" \
  -F wireguardId="123" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "config": "[Interface]\nPrivateKey = ...\nAddress = 10.0.0.2/32\nDNS = 1.1.1.1\n\n[Peer]\nPublicKey = ...\nEndpoint = wg.worldvpn.net:51820\nAllowedIPs = 0.0.0.0/0", "qrCodeBase64": "data:image/png;base64,iVBORw0KGgoAAA..." }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
wireguardId integer Optional
mode string Optional

Delete WireGuard Peer

POST

Remove a WireGuard configuration from the database and update the server to delete the peer.

Request Example

cURL (CLI) 
curl -X POST https://www.worldvpn.net/api/deleteWireGuardPeer \
  -F resellerUsername="Your Reseller Username" \
  -F resellerPassword="Your Reseller Password" \
  -F vpnUsername="VPN Username" \
  -F wireguardId="123" \
  -F mode="test"

Expected JSON Response

{ "status": "success", "message": "Config deleted." }

Request Parameters

Parameter Type Required
resellerUsername string Required
resellerPassword string Required
vpnUsername string Required
wireguardId integer Required
mode string Optional
FAQ

Integration & Developer FAQ

Common questions about integrating our white-label VPN Reseller API

Ready to Integrate?

Become a reseller and get full API access to manage VPN services programmatically.

Become a Reseller →