Heartbeat

post https://api.nodecraft.studio/v1/game-server/heartbeat

Heartbeat is used to keep the server status up to date and to ensure the server is still active and online. This endpoint will also return any moderation updates for players that need to be kicked or disconnected.

Responses

Response body

object

code

string

required

game_server.heartbeat.success

message

string

required

Successfully checked-in for server info.

success

boolean

required

true

data

object

required

sessions_active

array of uuids

required

An array of active session IDs for validation.

Active Sessions*

sessions_stale

array of uuids

required

An array of stale session IDs that need to be ejected from the server. These sessions are already closed, but the server is still reporting them as connected.

Stale Sessions*

kicks

array of objects

required

An array of kicks that have been issued to players on this server. The server must send a kick event and eject the session for this player.

Moderation: Kicks*

object

uuid

required

UUID of the kick

date_created

string | null

required

Date when the kick was created

reason

string | null

required

Only visible to the server owner & moderators. Documented reason for the kick or ban.

player

object

required

author

object

required

Only visible to the server owner & moderators. Owner or Moderator who performed the kick or ban. When null, it is a system or game issued ban.

since

string | null

required

The time that this data was fetched, and to use for the next heartbeat.

error

boolean

required

Language

Credentials

Header

Request


xxxxxxxxxx
1
POST /v1/game-server/heartbeat HTTP/1.1
2
Accept: application/json
3
Content-Type: application/json
4
Host: api.nodecraft.studio
5
Content-Length: 19
6
7
{"status":"online"}


xxxxxxxxxx
20
 
1
{
2
  "code": "game_server.heartbeat.success",
3
  "message": "Successfully checked-in for server info.",
4
  "success": true,
5
  "data": {
6
    "sessions_active": [
7
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
8
    ],
9
    "sessions_stale": [
10
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
11
    ],
12
    "kicks": [
13
      {
14
        "id": "00000000-0000-0000-0000-000000000000"
15
      }
16
    ],
17
    "since": "2024-01-07T00:00:00.000Z"
18
  },
19
  "error": false
20
}

200

401

404