Xeonr Developer Docs
Server APIAPI SpecificationServers

Get server details

POST
/serversapi.v1.ServerService/GetServer

Retrieve detailed information about a specific game server by its address, unique ID, or hostname.

Authorization

BearerAuth
AuthorizationBearer <token>

JWT access token obtained via logging in with an identity provider.

In: header

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

target?string

Server identifier - can be an IP:port, server ID, or hostname.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://server-api.sagl.app/serversapi.v1.ServerService/GetServer" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "server": {
    "id": "srv_abc123",
    "hostname": "string",
    "ipAddress": "192.168.1.1",
    "port": "7777",
    "address": "string",
    "name": "string",
    "isHosted": true,
    "isPassworded": true,
    "isOnline": true,
    "lastOnlineAt": "string",
    "capturedAt": "string",
    "players": {
      "currentPlayers": 0,
      "maxPlayers": 1000,
      "exceededSampLimit": true
    },
    "gamemode": "string",
    "language": "string",
    "rules": {
      "property1": "string",
      "property2": "string"
    },
    "networkDetails": {
      "country": "US",
      "asn": "string",
      "asnName": "string"
    },
    "saglMetadata": {
      "socialNetworks": {
        "property1": "string",
        "property2": "string"
      },
      "description": "string",
      "profileIcon": "string",
      "displayName": "string",
      "hostname": "string",
      "isSupporter": true
    },
    "saglOwners": [
      {
        "username": "string",
        "avatar": "string",
        "claimedAt": "string"
      }
    ]
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}