API Documentation for Android VPN Apps
Description: Get list of VPN servers assigned to your API key
Headers:
X-API-Key: YOUR_API_KEY
Authorization: Bearer YOUR_API_KEY (alternative)
Optional Parameters:
device_id (string): Unique device identifier
Response:
{
"success": true,
"data": {
"servers": [
{
"id": 1,
"server_name": "USA Server 1",
"country": "United States",
"flag_url": "https://...",
"status": "active"
}
],
"total": 1
}
}
Description: Get OpenVPN configuration for specific server
Headers:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Request Body:
{
"server_id": 1,
"device_id": "unique-device-id" (optional)
}
Response:
{
"success": true,
"data": {
"server": {
"id": 1,
"server_name": "USA Server 1",
"country": "United States",
"flag_url": "https://...",
"ovpn_config": "client\nremote ..."
}
}
}
{
"success": false,
"error": "Error message",
"code": "ERROR_CODE"
}
Common Error Codes:
MISSING_API_KEY - API key not providedINVALID_API_KEY - API key does not existAPI_DISABLED - API key is disabledLIMIT_EXCEEDED - Daily usage limit exceededSERVER_NOT_ACCESSIBLE - Server not assigned to this API