Server API
Retrieve detailed information about a specific VPN server
Server API
Access complete details for a specific VPN server. View configuration, location, connection info, and administrative settings.
Server Details
Complete configuration.
Location Info
City, country, continent.
Admin Config
SSH and management.
Endpoint Overview
/graphqlRetrieve complete details for a specific VPN server including network configuration, location, and administrative access settings.
Request Parameters
idInt!RequiredThe unique identifier of the server to retrieve.
GraphQL Query
query server($id: Int!) {
server(id: $id) {
id
hostName
publicIp
type
privateIp
city
country
continent
ports
description
hero
spot
zeus
bridgeIp
bridgeCountry
}
}Variables:
{
"id": 1
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query server($id: Int!) { server(id: $id) { id hostName publicIp city country continent type ports } }",
"variables": {
"id": 1
}
}'Response
{
"data": {
"server": {
"id": "1",
"hostName": "us-east-01.vpn.orbnet.com",
"publicIp": "203.0.113.50",
"type": "wireguard",
"privateIp": "10.0.1.1",
"city": "New York",
"country": "United States",
"continent": "North America",
"ports": "51820,443",
"description": "Primary US East Coast server",
"hero": true,
"spot": false,
"zeus": false,
"bridgeIp": null,
"bridgeCountry": null
}
}
}{
"errors": [
{
"message": "Server not found",
"path": ["server"],
"extensions": {
"code": "NOT_FOUND"
}
}
],
"data": null
}Response Fields
idID!Unique identifier for the server.
hostNameString!Fully qualified hostname of the server.
publicIpString!Public IP address for client connections.
typeString!VPN protocol type (wireguard, openconnect, etc.).
privateIpStringInternal network IP address.
portsStringAvailable connection ports (comma-separated).
cityString!City where the server is located.
countryString!Country where the server is located.
continentString!Continent classification.
heroBooleanFeatured/promoted server flag.
spotBooleanSpot instance indicator.
zeusBooleanZeus network enabled.
bridgeIpStringBridge server IP if applicable.
bridgeCountryStringBridge server country.
Related Endpoints
Sensitive Data
This endpoint returns administrative information. SSH credentials and keys are only accessible to admin users.
Modify Server Settings
Update server configuration and settings.