OrbVPNOrbVPN
TutorialsTroubleshootServicesAPIBusinessBlogDashboard

Servers API

Retrieve a complete list of all VPN servers with their detailed configuration

Servers

Servers API

Access the complete list of all VPN servers in your infrastructure. View configurations, locations, and status for every server.

Add Server

All Servers

Complete server inventory.

Global Network

Worldwide locations.

Full Config

Detailed settings.

Endpoint Overview

QUERY/graphql

Retrieve all VPN servers with complete configuration details including network settings, locations, and administrative information.

Authentication:Bearer Token
Required scopes:admin

GraphQL Query

query servers {
  servers {
    id
    hostName
    publicIp
    type
    privateIp
    city
    country
    continent
    ports
    description
    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 servers { servers { id hostName publicIp city country type ports hero } }"
  }'

Response

200Servers Retrieved Successfully
{
  "data": {
    "servers": [
      {
        "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 server",
        "hero": true,
        "spot": false,
        "zeus": false,
        "bridgeIp": null,
        "bridgeCountry": null
      },
      {
        "id": "2",
        "hostName": "eu-west-01.vpn.orbnet.com",
        "publicIp": "198.51.100.25",
        "type": "openconnect",
        "privateIp": "10.0.2.1",
        "city": "Amsterdam",
        "country": "Netherlands",
        "continent": "Europe",
        "ports": "443,8443",
        "description": "EU West primary",
        "hero": true,
        "spot": false,
        "zeus": true,
        "bridgeIp": null,
        "bridgeCountry": null
      },
      {
        "id": "3",
        "hostName": "asia-01.vpn.orbnet.com",
        "publicIp": "192.0.2.100",
        "type": "wireguard",
        "privateIp": "10.0.3.1",
        "city": "Singapore",
        "country": "Singapore",
        "continent": "Asia",
        "ports": "51820",
        "description": "APAC primary",
        "hero": false,
        "spot": true,
        "zeus": false,
        "bridgeIp": null,
        "bridgeCountry": null
      }
    ]
  }
}

Response Fields

idID!

Unique server identifier.

hostNameString!

Server hostname.

publicIpString!

Public IP address.

typeString!

VPN protocol type.

privateIpString

Internal IP address.

portsString

Available connection ports.

descriptionString

Server description.

cityString!

Server city.

countryString!

Server country.

continentString!

Server continent.

heroBoolean

Featured server flag.

spotBoolean

Spot instance flag.

zeusBoolean

Zeus network enabled.

Server Types

WireGuard

Modern, fast protocol.

OpenConnect

SSL/TLS-based VPN.

VLESS

Proxy protocol.

Reality

Advanced obfuscation.

Related Endpoints

QUERYSingle Server

Get specific server

MUTATIONCreate Server

Add new server

QUERYClient Servers

User-facing list

QUERYGateways

Network gateways

Admin Only

This endpoint returns full server configuration including sensitive network details. Access is restricted to admin users.

Add New Server

Expand your VPN infrastructure with additional servers.

Create Server

Server API

Previous Page

Client Servers API

Next Page

On this page

Endpoint Overview
GraphQL Query
Response
Response Fields
Server Types
Related Endpoints