Skip to main content
GET
/
api
/
v3
/
servers
List servers
curl --request GET \
  --url https://playflow.dev/api/api/v3/servers \
  --header 'api-key: <api-key>'
{
  "total": 123,
  "servers": [
    {
      "instance_id": "<string>",
      "name": "<string>",
      "status": "launching",
      "network_ports": [
        {
          "name": "<string>",
          "internal_port": 123,
          "external_port": 123,
          "protocol": "udp",
          "host": "<string>",
          "tls_enabled": true
        }
      ],
      "startup_args": "<string>",
      "service_type": "match_based",
      "compute_size": "<string>",
      "region": "<string>",
      "version_tag": "<string>",
      "version": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "stopped_at": "2023-11-07T05:31:56Z",
      "auto_restart": true,
      "custom_data": {},
      "ttl": 123,
      "is_pool_server": true,
      "pool_claimed_at": "2023-11-07T05:31:56Z",
      "match_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "offset": 123,
  "has_more": true
}

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.