Skip to main content
GET
/
v2
/
servers
/
{instance_id}
Get Game Server Details
curl --request GET \
  --url https://api.computeflow.cloud/v2/servers/{instance_id} \
  --header 'api-key: <api-key>'
{
  "name": "<string>",
  "instance_id": "<string>",
  "network_ports": [
    {
      "name": "<string>",
      "internal_port": 123,
      "external_port": 123,
      "protocol": "udp",
      "host": "<string>",
      "tls_enabled": false
    }
  ],
  "status": "launching",
  "startup_args": "",
  "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": false,
  "custom_data": {},
  "ttl": 123,
  "is_pool_server": false,
  "pool_claimed_at": "2023-11-07T05:31:56Z"
}

Headers

​
api-key
string
required

PlayFlow API Key

Path Parameters

​
instance_id
string
required

Unique identifier (UUID) of the server instance to retrieve.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

Successful Response

​
name
string
required
​
instance_id
string
​
network_ports
PortMapping · object[]
​
status
enum<string>
default:launching
Available options:
launching,
running,
stopped
​
startup_args
string | null
default:""
​
service_type
enum<string>
default:match_based
Available options:
match_based,
persistent_world
​
compute_size
string
default:""
​
region
string
default:""
​
version_tag
string
default:""
​
version
integer | null
​
started_at
string<date-time> | null
​
stopped_at
string<date-time> | null
​
updated_at
string<date-time> | null

Last time the server was restarted/updated. Used for TTL calculation after restarts.

​
auto_restart
boolean | null
default:false

If True, the server will automatically restart on failure and is treated as persistent.

​
custom_data
Custom Data · object
​
ttl
integer | null
​
is_pool_server
boolean
default:false

If True, this is a pre-warmed pool server

​
pool_claimed_at
string<date-time> | null

Timestamp when claimed from pool (for billing split)