VLESS Configuration
Retrieve a VLESS VPN configuration for a specific server, including XTLS-Reality settings and share link.
Get VLESS Configuration
Retrieve a complete VLESS configuration for a specific server. VLESS with XTLS-Reality provides strong obfuscation, making VPN traffic appear as regular HTTPS traffic. The response includes all connection parameters and a shareable vless:// link.
/api/v1/vpn/servers/{serverId}/vlessGet VLESS configuration for a specific server
| Parameter | Type | Required | Description |
|---|---|---|---|
serverId | integer | Required | The numeric ID of the VPN server |
When to Use VLESS
VLESS with XTLS-Reality is recommended when connecting from networks with deep packet inspection (DPI) or VPN blocking. It disguises VPN traffic as standard HTTPS, making it very difficult to detect and block.
curl -X GET https://api.orbai.world/api/v1/vpn/servers/101/vless \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"{
"success": true,
"data": {
"address": "203.0.113.10",
"port": 443,
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"flow": "xtls-rprx-vision",
"encryption": "none",
"network": "tcp",
"security": "reality",
"reality": {
"public_key": "xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=",
"short_id": "a1b2c3d4",
"server_name": "www.microsoft.com",
"fingerprint": "chrome"
},
"tls_settings": {
"server_name": "www.microsoft.com",
"alpn": ["h2", "http/1.1"],
"fingerprint": "chrome"
},
"share_link": "vless://a1b2c3d4-e5f6-7890-abcd-ef1234567890@203.0.113.10:443?encryption=none&flow=xtls-rprx-vision&security=reality&sni=www.microsoft.com&fp=chrome&pbk=xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg%3D&sid=a1b2c3d4&type=tcp#OrbVPN-US-NYC"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or expired access token"
}
}{
"success": false,
"error": {
"code": "ACCESS_DENIED",
"message": "Your subscription plan does not include access to this server. Please upgrade your plan."
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Server with the specified ID does not exist"
}
}Response Fields
| Field | Type | Description |
|---|---|---|
address | string | Server IP address |
port | integer | Connection port (typically 443) |
uuid | string | Unique user ID for VLESS authentication |
flow | string | XTLS flow control setting |
encryption | string | Encryption method (typically "none" as XTLS handles encryption) |
network | string | Transport network type (tcp, ws, grpc) |
security | string | Security layer (reality, tls) |
reality.public_key | string | Reality public key for key exchange |
reality.short_id | string | Short ID for Reality authentication |
reality.server_name | string | SNI server name used for camouflage |
reality.fingerprint | string | TLS client fingerprint to mimic |
tls_settings.server_name | string | TLS SNI value |
tls_settings.alpn | string[] | Application-Layer Protocol Negotiation values |
tls_settings.fingerprint | string | Browser fingerprint to emulate |
share_link | string | Complete vless:// URI for importing into compatible clients |
Share Link
The share_link field contains a standard vless:// URI that can be imported directly into V2Ray, Xray, Hiddify, V2RayNG, Nekoray, and other compatible clients. You can also encode it as a QR code for easy mobile setup.
UUID Security
The uuid is unique to your account and acts as your authentication credential for the VLESS connection. Do not share it with others, as they could use your connection quota.