GET
List servers

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.

Query Parameters

project_id
string

Which project to act on. Required when authenticating with a developer session (bearer_auth), which names no project of its own; ignored when authenticating with an API key, which carries its project already.

A project belonging to another account returns PROJECT_NOT_FOUND (7001) rather than a 403, so this cannot be used to probe for project ids.

Example:

"proj_abc123"

status
enum<string>

Filter by lifecycle status.

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

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"

version_tag
string

Filter by the build name the server was launched from.

match_id
string
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip before collecting the result set.

Required range: x >= 0

Response

A page of servers.

Envelope fields shared by every list endpoint.

total
integer
required

Total number of items matching the query, ignoring pagination.

Example:

100

limit
integer
required
Example:

50

offset
integer
required
Example:

0

has_more
boolean
required

Whether more items exist past offset + limit.

Example:

true

data
object[]
required