create
Description
Create a new dynamic server.
Code Examples
Request
POST
https://api.rivet.gg/games/{game_id}/environments/{environment_id}/servers# Write the request body to body.json before running
curl -X POST -d '@body.json' 'https://api.rivet.gg/games/{game_id}/environments/{environment_id}/servers'
Request Parameters
game_id
required path parameterenvironment_id
required path parameterRequest Body
datacenter
required stringlifecycle
objectkill_timeout
integerThe duration to wait for in milliseconds before killing the server. This should be set to a safe default, and can be overridden during a DELETE request if needed.
network
required objectmode
stringports
required map<string, object>ports.<port>
objectinternal_port
integerprotocol
required stringrouting
objectgame_guard
objecthost
objectresources
required objectcpu
required integerThe number of CPU cores in millicores, or 1/1000 of a core. For example, 1/8 of a core would be 125 millicores, and 1 core would be 1000 millicores.
memory
required integerThe amount of memory in megabytes
runtime
required objectarguments
array<string>arguments[*]
stringbuild
required stringenvironment
map<string, string>environment.<environment>
stringtags
required objectResponse Body
server
required objectThe server that was created
created_at
required integerdatacenter
required stringdestroyed_at
integerenvironment
required stringid
required stringlifecycle
required objectkill_timeout
integerThe duration to wait for in milliseconds before killing the server. This should be set to a safe default, and can be overridden during a DELETE request if needed.
network
required objectmode
stringports
required map<string, object>ports.<port>
objectinternal_port
integerprotocol
required stringpublic_hostname
stringpublic_port
integerrouting
required objectgame_guard
objecthost
objectresources
required objectcpu
required integerThe number of CPU cores in millicores, or 1/1000 of a core. For example, 1/8 of a core would be 125 millicores, and 1 core would be 1000 millicores.
memory
required integerThe amount of memory in megabytes
runtime
required objectarguments
array<string>arguments[*]
stringbuild
required stringenvironment
map<string, string>environment.<environment>
stringstarted_at
integertags
required object