GET
/
v2
/
servers
/
List Game Servers
curl --request GET \
  --url https://api.computeflow.cloud/v2/servers/ \
  --header 'api-key: <api-key>'
{
  "total_servers": 123,
  "servers": [
    {
      "instance_id": "<string>",
      "name": "<string>",
      "network_ports": [
        {
          "name": "<string>",
          "internal_port": 123,
          "external_port": 123,
          "protocol": "udp",
          "host": "<string>",
          "tls_enabled": false
        }
      ],
      "status": "launching",
      "startup_args": "<string>",
      "service_type": "match_based",
      "compute_size": "",
      "region": "",
      "version_tag": "",
      "version": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "stopped_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "auto_restart": true,
      "custom_data": {},
      "ttl": 123,
      "is_pool_server": false,
      "pool_claimed_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

api-key
string
required

PlayFlow API Key

Query Parameters

include_launching
boolean
default:false

Include servers in 'launching' state.

include_pool
boolean
default:false

Include pool servers (pre-warmed servers in 'stopped' state).

Response

Successful Response

Schema for list of servers.

total_servers
integer
required

Number of servers

servers
Instance · object[]
required

List of servers