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.

Body Params
string
enum
required

The current status of the server.

Allowed:
sessions
array of uuids
required

Array of active session IDs.

Active Sessions*
string | null
required

The last time the server sent a heartbeat. Will be used to show unactioned kicks, etc. since this date.

Responses

Language
Credentials
Header
Request
Response
Choose an example:
application/json