Heartbeat

POST

/v1/servers/{id}/heartbeat

curl --request POST \
  --url https://api.gampeon.com/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/heartbeat \
  --header 'Content-Type: application/json' \
  --header 'x-server-key: <x-server-key>' \
  --data '{ "players": 1, "maxPlayers": 1, "port": 1, "address": "example", "tags": [ "example" ], "language": "example", "packages": [ { "name": "example", "version": "example" } ] }'

• Production

Send every 30 seconds. Servers without a heartbeat for 90 seconds disappear from the server browser. Without address, the IP of the request is used (set sv_publicAddress in server.cfg to override it).

Rate limit: 20 per minute per server and IP.

Authorizations

• serverKey

Parameters

Path Parameters

id

required

string format: uuid

Server ID

Header Parameters

x-server-key

required

string

Key from registering the server

Request Body^required

Media typeapplication/json

object

players

required

Players online (0 to maxPlayers)

integer

maxPlayers

required

integer

>= 1 <= 2048

port

required

integer

>= 1 <= 65535

address

Host name or IP

string

<= 253 characters /^[A-Za-z0-9.\-:]*$/

tags

Up to 10 tags, such as roleplay or racing

Array<string>

<= 10 items

language

Language code such as en or de-DE

string

<= 8 characters

packages

Game packages the server has loaded, up to 8. Players get them through the launcher when they join; they must be ready in the project the server is linked to.

Array<object>

<= 8 items

object

name

required

string

version

required

string

Example ^generated

{
  "players": 1,
  "maxPlayers": 1,
  "port": 1,
  "address": "example",
  "tags": [
    "example"
  ],
  "language": "example",
  "packages": [
    {
      "name": "example",
      "version": "example"
    }
  ]
}

Responses

200

Accepted

Media typeapplication/json

object

ok

required

nextHeartbeatInMs

required

integer

Example

{
  "ok": true
}

400

Error codes: invalid_field

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"
}

401

Error codes: invalid_server_key

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"
}

429

Limit: 20 per minute per server and IP. Error codes: rate_limited

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"
}