Xeonr Developer Docs
Server APIAPI SpecificationServers

Update claimed server

POST
/serversapi.v1.ServerService/UpdateClaimedServer

Update the metadata of a claimed server including display name, description, social links, and profile icon.

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

ipAddress?string

IP address of the server to update.

port?integer

Port number of the server.

Default"7777"
Formatint32
Range1 <= value <= 65535
saglMetadata?

Updated metadata for the server.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://server-api.sagl.app/serversapi.v1.ServerService/UpdateClaimedServer" \  -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": {}
    }
  ]
}

Unclaim server POST

Release ownership of a previously claimed server. This removes your management access to the server.

Statistics

Endpoints for retrieving aggregate statistics such as current player counts, nearby servers, and distribution data for game versions, modes, languages, countries, and ASNs.