Skip to main content

Find game servers

Find game servers by ID or name.

Query Parameters
id integer

Game server ID

name string

Game server name (partial match on name, short_name or display_name)

page integer

Page number

per_page integer

Possible values: 1 ≤ value ≤ 100

Items per page

Responses
200

successful operation

Schema — OPTIONAL
data object[] — 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
meta object — OPTIONAL
current_page integer — OPTIONAL
from integer — OPTIONAL
last_page integer — OPTIONAL
path string — OPTIONAL
per_page integer — OPTIONAL
to integer — OPTIONAL
total integer — OPTIONAL
400

Invalid request

Schema — OPTIONAL
error string — OPTIONAL
404

No game servers found

Schema — OPTIONAL
error string — OPTIONAL