GET
Get a server

Authorizations

api-key
string
header
required

Per-project server key, prefixed sk_live_. Full access to every endpoint. Keep it on your backend: never ship it in a game binary.

Path Parameters

instance_id
string
required

Server instance identifier.

Example:

"abc123"

Response

The server.

instance_id
string
required
Example:

"abc123"

name
string
required
Example:

"ranked-2v2-iad-01"

status
enum<string>
required
Available options:
launching,
running,
stopped
region
enum<string>
required

Datacenter region a server runs in. 16 regions are supported.

Every region is available to every project. Capacity is Simpl's problem, not yours: pick the region closest to your players.

Available options:
ams,
arn,
bom,
cdg,
dfw,
ewr,
fra,
iad,
lax,
lhr,
nrt,
ord,
sin,
sjc,
syd,
yyz
Example:

"iad"

tier
enum<string>
required

Machine tier, named transparently as <cpu>-<memory>. 1x = one shared vCPU, 2p = two performance (dedicated) vCPUs, 2g = 2 GB of memory. No guessing what small or nano means.

Available options:
1x-256,
1x-512,
1x-1g,
1x-2g,
2x-2g,
2x-4g,
4x-4g,
4x-8g,
1p-2g,
1p-4g,
1p-8g,
2p-16g
Example:

"1x-2g"

created_at
string<date-time>
required
updated_at
string<date-time>
required
network_ports
object[]
startup_args
string

Arguments appended to the executable's command line.

Example:

"-log"

custom_data
object

Free-form developer-defined data. Carried verbatim and surfaced to the game server in /simpl/its_simpl.json. Soft cap of 64KB serialized; exceeding it returns CUSTOM_DATA_TOO_LARGE (error_id 2008).

Example:
ttl
integer

Seconds before Simpl stops this server automatically. 0 or omitted means no TTL.

Required range: x >= 0
Example:

3600

match_id
string

Match this server was created for, if any.

Example:

"xyz789"

auto_restart
boolean
default:false

Restart the machine automatically if the process exits.

version_tag
string

Build name requested at creation time.

Example:

"1.2.3"

version
integer

Resolved integer build version actually running.

Example:

12

started_at
string<date-time> | null
stopped_at
string<date-time> | null