Skip to main content

Get game server details

Retrieve detailed information about a specific game server.

Path Parameters
gameserver_id integer — REQUIRED

Example: 57294

Responses
200

successful operation

Schema — OPTIONAL
id integer — OPTIONAL
name string — OPTIONAL
display_name string — OPTIONAL
short_name string — OPTIONAL
blueprint_version_id integer — OPTIONAL
config_template_id integer — OPTIONAL
machine_id integer — OPTIONAL
cluster_id uuid — OPTIONAL
cluster_chat_name string — OPTIONAL
app_id integer — OPTIONAL
discord object — OPTIONAL
name string — OPTIONAL
connection object — OPTIONAL
ip_address ipv4 — OPTIONAL
game_port integer — OPTIONAL
query_port integer — OPTIONAL
rcon_port integer — OPTIONAL
activity object — OPTIONAL
status boolean — OPTIONAL

Whether the server is healthy/online

online_characters_count integer — OPTIONAL

Number of players currently online

backup object — OPTIONAL
backup_on_shutdown boolean — OPTIONAL
backup_on_update boolean — OPTIONAL
last_healthy_at date-time — OPTIONAL
last_error_at date-time — OPTIONAL
created_at date-time — OPTIONAL
updated_at date-time — OPTIONAL
404

Game server not found

Schema — OPTIONAL
error string — OPTIONAL