Your servers

GET

/v1/me/servers

curl --request GET \
  --url https://api.gampeon.com/v1/me/servers \
  --header 'Authorization: Bearer <token>'

• Production

All your servers, including offline ones. Never contains the server key.

Access tokens: scope servers:read.

Authorizations

• session
• accessToken
  servers:read

Responses

200

Servers

Media typeapplication/json

object

servers

required

Array<object>

object

id

required

Server ID

string format: uuid

name

required

string

description

required

string

website

required

One of:

string

string

null

null

owner

required

object

handle

required

Unique handle

string

/^[a-z0-9_]{3,24}$/

displayName

required

string

avatar

One of:

string

Image path relative to the API (/v1/media/…). null without an image.

string

null

null

online

required

Sent a heartbeat in the last 90 seconds

boolean

address

required

One of:

string

Host name or IP address players connect to

string

null

null

port

required

One of:

integer

integer

null

null

players

required

integer

maxPlayers

required

integer

tags

required

Array<string>

language

required

One of:

string

Language code such as en or de-DE

string

null

null

lastSeen

required

Last heartbeat (Unix time in milliseconds)

integer format: int64

peakPlayers

required

Highest player count reported over two consecutive heartbeats

integer

project

required

One of:

object

object

slug

required

string

title

required

string

null

null

Example ^generated

{
  "servers": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example",
      "website": "example",
      "owner": {
        "handle": "example",
        "displayName": "example",
        "avatar": "example"
      },
      "online": true,
      "address": "example",
      "port": 1,
      "players": 1,
      "maxPlayers": 1,
      "tags": [
        "example"
      ],
      "language": "example",
      "lastSeen": 1,
      "peakPlayers": 1,
      "project": {
        "slug": "example",
        "title": "example"
      }
    }
  ]
}

401

Error codes: unauthorized

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: insufficient_scope, token_not_allowed

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}