0xDocs 0x.limo

Docs / REST API

Game servers

Generated reference for the 4 /v1/gameservers operations of the 0x REST API.

Generated from steamworks sg-backend/openapi.yaml at build 3a4a58e45c+dirty. Do not edit by hand.

Guide: Lobbies and matchmaking. Errors are {"error": "..."} with the status (errors); limits are in rate limits.

MethodPathAuthSummary
POST/v1/gameservers/logonNone{appid, token?}
PUT/v1/gameservers/meGame-server sessionGame server heartbeat with its state
DELETE/v1/gameservers/meGame-server sessionUnlist
GET/v1/gameservers/license/{steamid}/{appid}Game-server sessionGame servers:

#POST /v1/gameservers/logon

{appid, token?} → {steamid, session, public_ip, stream}

Auth: None: no token needed.

StatusResponse
200OK
401Invalid server token
bash
curl -s -X POST "https://api.0x.limo/v1/gameservers/logon"

#PUT /v1/gameservers/me

Game server heartbeat with its state (listed while fresh, 90 s)

Auth: Game-server session: Authorization: Bearer gs-... from game-server logon.

StatusResponse
200OK Ok
bash
curl -s -X PUT "https://api.0x.limo/v1/gameservers/me" \
  -H "Authorization: Bearer $ZEROX_GS_TOKEN"

#DELETE /v1/gameservers/me

Unlist

Auth: Game-server session: Authorization: Bearer gs-... from game-server logon.

StatusResponse
200OK Ok
bash
curl -s -X DELETE "https://api.0x.limo/v1/gameservers/me" \
  -H "Authorization: Bearer $ZEROX_GS_TOKEN"

#GET /v1/gameservers/license/{steamid}/{appid}

Game servers: does this player own the app

Auth: Game-server session: Authorization: Bearer gs-... from game-server logon.

ParameterInTypeRequiredDescription
steamidpathstringyes64-bit SteamID as a decimal string
appidpathnumberyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/gameservers/license/$STEAMID/$APPID" \
  -H "Authorization: Bearer $ZEROX_GS_TOKEN"