Skip to main content
GET
Get a server

Authorizations

Authorization
string
header
required

API token created in the dashboard under Integrations > API. Tokens start with gci_.

Path Parameters

serverId
string<uuid>
required
Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Response

The server.

A game server that receives delivery commands. PLUGIN and SCRIPT servers pull commands with a connector token; RCON servers are reached by the platform.

createdAt
string<date-time>
Example:

"2026-09-25T13:05:00.000Z"

id
string<uuid>
Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
Example:

"0f8fad5b-d9cb-469f-a165-70867728950e"

name
string
Example:

"Survival"

rcon
object

RCON target. Present only when type is RCON; the password is never returned.

token
string

Connector token. Returned only when a PLUGIN or SCRIPT server is created; store it now, it is not shown again by the API.

Example:

"5f0c7a6e-9d4b-4b47-a0e4-6f1c2c9b8a11"

type
enum<string>
Available options:
PLUGIN,
SCRIPT,
RCON
Example:

"PLUGIN"