Launch a session
Start a new game session in a specific region. Each session needs a unique ID, which you'll need to create yourself. (We recommend using a UUID.)
The unique ID for the session. (Best to use a UUID.)
The location or region that you'd prefer to host the game session in. (Check our regions and locations page.)
The name of the image for your game, hosted inside a container.
The list of envrionment variables you want to feed the container when it starts.
The list of program console arguments to feed to the application that's hosted inside the container.
Tells us whether we must automatically restart this session if it fails to launch. (We won't restart if you manually shut it down.)
Add your own metadata about the session that we'll store inside the configuration.
Tag of the image that the session will run. This tag needs to be available or it'll throw a 404. If you don't specify a priority, we'll run it with the highest priority.
Use this to collect details like CPU, memory and network information. Useful for debugging.
although not depicted in the API response, 420 is still