Skip to main content
GET
List servers

Authorizations

api-key
string
header
required

Query Parameters

include_launching
enum<string>
default:false

Include servers in "launching" status. By default only "running" servers are returned.

Available options:
true,
false
include_pool
enum<string>
default:false

Include pre-provisioned pool servers (stopped machines waiting to be claimed).

Available options:
true,
false
limit
integer
default:50

Maximum number of servers per page (1–100). Defaults to 50.

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

Number of servers to skip for pagination. Defaults to 0.

Required range: x >= 0

Response

200 - application/json

Paginated list of servers matching the query filters.

Paginated list of game server instances.

total
number
required

Total number of servers matching the query filters.

servers
object[]
required

Array of server instances for the current page.

limit
number
required

Maximum number of items per page (as requested).

offset
number
required

Number of items skipped (for pagination).

has_more
boolean
required

True if there are more servers beyond this page. Use offset + limit to fetch the next page.