Mining Platform UI Integration
Configure server display and feature mapping for client applications
Mining Platform UI Integration
Configure how servers appear in client applications. Map server features to UI elements for optimal user experience and intuitive server selection.
UI Mapping
Configure server display settings.
Visual Assets
Assign icons and images.
Feature Flags
Control visible features.
Endpoint Overview
/graphqlConfigure server UI presentation settings including display names, icons, feature badges, and sorting preferences for client applications.
Request Parameters
serverIdInt!RequiredThe server ID to configure UI settings for.
displayNameStringCustom display name for the server in clients.
iconUrlStringURL to custom server or country icon.
flagEmojiStringCountry flag emoji for quick identification.
features[String]List of feature badges to display (e.g., "streaming", "gaming", "p2p").
priorityIntSort priority for server lists (higher = shown first).
recommendedBooleanMark as recommended server.
premiumBooleanDesignate as premium-only server.
GraphQL Mutation
mutation updateServerUI($serverId: Int!, $settings: ServerUISettings!) {
updateServerUI(serverId: $serverId, settings: $settings) {
success
server {
id
hostName
displayName
features
priority
recommended
}
}
}Variables:
{
"serverId": 12345,
"settings": {
"displayName": "US West - Los Angeles",
"features": ["streaming", "gaming", "low-latency"],
"priority": 100,
"recommended": true,
"premium": false
}
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
-d '{
"query": "mutation updateServerUI($serverId: Int!, $settings: ServerUISettings!) { updateServerUI(serverId: $serverId, settings: $settings) { success server { id displayName features } } }",
"variables": {
"serverId": 12345,
"settings": {
"displayName": "US West - Los Angeles",
"features": ["streaming"],
"recommended": true
}
}
}'Response
{
"data": {
"updateServerUI": {
"success": true,
"server": {
"id": "12345",
"hostName": "us-west-1.vpn.example.com",
"displayName": "US West - Los Angeles",
"features": ["streaming", "gaming", "low-latency"],
"priority": 100,
"recommended": true
}
}
}
}{
"errors": [
{
"message": "Invalid feature: unknown-feature",
"path": ["updateServerUI"],
"extensions": {
"code": "INVALID_FEATURE",
"validFeatures": ["streaming", "gaming", "p2p", "low-latency", "secure"]
}
}
],
"data": null
}Feature Badges
Streaming
Optimized for video streaming services.
Gaming
Low-latency optimized for gaming.
P2P
Supports peer-to-peer traffic.
Secure
Enhanced security features enabled.
UI Display Options
Server Name
Feature Badges
Priority Sorting
Recommendations
Best Practices
Clear Names
Use descriptive, location-based names.
Accurate Features
Only tag features actually supported.
Regional Priority
Prioritize servers by user proximity.
Premium Balance
Balance premium and free server offerings.
Related Endpoints
Client Sync
UI changes are reflected in client applications after they refresh their server list, typically within a few minutes.
Preview Client View
See how your servers appear to users in the client applications.