Mining Servers API
Discover and configure available servers for optimal performance routing
Mining Servers API
Discover available servers and configure optimal routing. Mining analyzes server performance, availability, and proximity to provide the best connection options.
Server Discovery
Find optimal servers automatically.
Performance Analysis
Analyze server metrics and load.
Smart Routing
Optimize connection paths.
Endpoint Overview
/graphqlTrigger server mining operation to discover, analyze, and optimize server configurations based on current network conditions and performance metrics.
Request Parameters
regionStringFilter mining to specific geographic region.
protocolStringFilter by VPN protocol type.
minCapacityIntMinimum capacity threshold for inclusion.
GraphQL Mutation
mutation miningServers($region: String, $protocol: String) {
miningServers(region: $region, protocol: $protocol) {
success
serversAnalyzed
serversUpdated
optimizationReport {
totalServers
activeServers
averageLoad
recommendations
}
}
}Variables:
{
"region": "North America",
"protocol": "wireguard"
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
-d '{
"query": "mutation miningServers($region: String) { miningServers(region: $region) { success serversAnalyzed serversUpdated } }",
"variables": {
"region": "North America"
}
}'Response
{
"data": {
"miningServers": {
"success": true,
"serversAnalyzed": 45,
"serversUpdated": 12,
"optimizationReport": {
"totalServers": 45,
"activeServers": 42,
"averageLoad": 67.5,
"recommendations": [
"Consider adding capacity in EU West region",
"Server srv_123 showing high latency"
]
}
}
}
}{
"errors": [
{
"message": "Mining operation failed",
"path": ["miningServers"],
"extensions": {
"code": "MINING_ERROR"
}
}
],
"data": null
}Mining Operations
Latency Check
Measure response times to all servers.
Capacity Analysis
Evaluate current load and availability.
Health Verification
Confirm server accessibility and status.
Route Optimization
Calculate optimal connection paths.
Use Cases
Load Balancing
Optimize user distribution across servers.
Performance Tuning
Identify and address bottlenecks.
Capacity Planning
Identify regions needing more servers.
Health Monitoring
Detect failing or degraded servers.
Related Endpoints
Scheduled Mining
For optimal performance, run mining operations during off-peak hours or set up scheduled mining tasks.
View Mining Results
Check your server fleet status and see the results of mining operations.