Client Servers API
Retrieve VPN servers available to clients with load and connection information
Client Servers API
Access the list of VPN servers available to users. View locations, connection counts, and congestion levels for server selection.
User-Facing
Client-visible servers.
Load Info
Connection counts.
Congestion
Server load levels.
Endpoint Overview
/graphqlRetrieve all VPN servers available to clients including location information, connected user counts, and congestion levels.
GraphQL Query
query clientServers {
clientServers {
id
hostName
publicIp
city
country
description
continent
connectedUserCount
congestionLevel
hero
spot
zeus
bridgeIp
bridgeCountry
}
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query clientServers { clientServers { id hostName city country connectedUserCount congestionLevel hero } }"
}'Response
{
"data": {
"clientServers": [
{
"id": "1",
"hostName": "us-east-01.vpn.orbnet.com",
"publicIp": "203.0.113.50",
"city": "New York",
"country": "United States",
"description": "Fast US East Coast server",
"continent": "North America",
"connectedUserCount": 245,
"congestionLevel": "low",
"hero": true,
"spot": false,
"zeus": false,
"bridgeIp": null,
"bridgeCountry": null
},
{
"id": "2",
"hostName": "eu-west-01.vpn.orbnet.com",
"publicIp": "198.51.100.25",
"city": "Amsterdam",
"country": "Netherlands",
"description": "High-speed EU server",
"continent": "Europe",
"connectedUserCount": 512,
"congestionLevel": "medium",
"hero": true,
"spot": false,
"zeus": true,
"bridgeIp": null,
"bridgeCountry": null
},
{
"id": "3",
"hostName": "asia-01.vpn.orbnet.com",
"publicIp": "192.0.2.100",
"city": "Singapore",
"country": "Singapore",
"description": "APAC optimized server",
"continent": "Asia",
"connectedUserCount": 89,
"congestionLevel": "low",
"hero": false,
"spot": true,
"zeus": false,
"bridgeIp": null,
"bridgeCountry": null
}
]
}
}Response Fields
idID!Unique server identifier.
hostNameString!Server hostname for connections.
publicIpString!Public IP address.
cityString!Server city location.
countryString!Server country.
continentString!Geographic continent.
descriptionStringUser-friendly description.
connectedUserCountInt!Number of currently connected users.
congestionLevelString!Current load level (low, medium, high).
heroBooleanFeatured/recommended server.
spotBooleanSpot instance indicator.
zeusBooleanZeus bridge enabled.
Congestion Levels
Low
Optimal performance, few users.
Medium
Normal load, good performance.
High
Heavy load, may affect speed.
Hero Servers
Featured high-capacity nodes.
Related Endpoints
Server Selection
Use the congestionLevel and connectedUserCount fields to help users select optimal servers. Hero servers are typically high-capacity and recommended.
Get Sorted Server List
Retrieve servers sorted by congestion, location, or other criteria.