Headers
PlayFlow API Key
Body
Configuration for the new server.
The name of the server instance
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
Custom arguments to pass to the server
Server size type - affects resources and pricing. Use 'persistent-*' sizes for long-running servers.
micro
, small
, medium
, large
, xlarge
, dedicated-small
, dedicated-medium
, dedicated-large
, dedicated-xlarge
, persistent-small
, persistent-medium
, persistent-large
, persistent-xlarge
The name of the build to use for this server. Defaults to 'default'.
The specific version of the build to use. If not provided, the latest version will be used.
Time to live for the server in seconds (60-86400). Ignored for persistent servers.
60 <= x <= 86400
Whether the server should automatically restart on failure. Always true for persistent servers.
Custom data to pass to the server
Response
Successful Response
Schema for server start response.
Unique server instance ID
Server name
Provider region
Server status (always 'launching' for new servers)
List of network port mappings with connectivity information including IPs, internal and external ports, and protocols
Server compute size
The name of the build used by the server.
The specific version number of the build used by the server.
Server start time