Skip to main content
POST
/
v2
/
servers
/
start
Start a New Game Server
curl --request POST \
  --url https://api.computeflow.cloud/v2/servers/start \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "startup_args": "<string>",
  "region": "<string>",
  "compute_size": "small",
  "version_tag": "<string>",
  "version": 123,
  "ttl": 43230,
  "auto_restart": true,
  "custom_data": {}
}'
{
  "instance_id": "<string>",
  "name": "<string>",
  "status": "launching",
  "region": "<string>",
  "network_ports": [
    {
      "name": "<string>",
      "internal_port": 123,
      "external_port": 123,
      "protocol": "udp",
      "host": "<string>",
      "tls_enabled": false
    }
  ],
  "compute_size": "small",
  "version_tag": "",
  "version": 123,
  "started_at": "2023-11-07T05:31:56Z"
}

Headers

api-key
string
required

PlayFlow API Key

Body

application/json

Configuration for the new server.

name
string
required

The name of the server instance

region
string
required

Region for the server deployment. Must be one of: us-east, us-west, eu-north, eu-west, eu-uk, ap-south, sea, ea, ap-north, ap-southeast, south-africa, south-america-brazil, south-america-chile

startup_args
string | null

Custom arguments to pass to the server

compute_size
enum<string>

Server size type - affects resources and pricing. Use 'persistent-*' sizes for long-running servers.

Available options:
micro,
small,
medium,
large,
xlarge,
dedicated-small,
dedicated-medium,
dedicated-large,
dedicated-xlarge,
persistent-small,
persistent-medium,
persistent-large,
persistent-xlarge
version_tag
string | null

The name of the build to use for this server. Defaults to 'default'.

version
integer | null

The specific version of the build to use. If not provided, the latest version will be used.

ttl
integer | null

Time to live for the server in seconds (60-86400). Ignored for persistent servers.

Required range: 60 <= x <= 86400
auto_restart
boolean | null
default:false

Whether the server should automatically restart on failure. Always true for persistent servers.

custom_data
object | null

Custom data to pass to the server

Response

Successful Response

Schema for server start response.

instance_id
string
required

Unique server instance ID

name
string
required

Server name

region
string
required

Provider region

status
string
default:launching

Server status (always 'launching' for new servers)

network_ports
PortMapping · object[]

List of network port mappings with connectivity information including IPs, internal and external ports, and protocols

compute_size
string
default:small

Server compute size

version_tag
string
default:""

The name of the build used by the server.

version
integer | null

The specific version number of the build used by the server.

started_at
string<date-time> | null

Server start time

I