2min
/session

POST
Allocate a new game session in a specific region. Each session is to be identified by a
unique identifier that is provided by the caller. It is recommended to use a UUID.
BODY PARAMETERS
body
object
idstring
The unique identifier of the session.
locationstring
The location or region that the game session is preferred to be hosted in.
imagestring
The name of the image of the game to host inside a container.
envobject
The list of environment variables to feed the container on startup.
argsstring[]
The list of program console arguments to feed to the application hosted
inside the container.
restartboolean
Indicates whether this session must be automatically restarted on failure.
The container will not be restarted in case of a manual termination.
labelsobject
The collection of user-defined key/value metadata stored inside the 
configuration of the session.
RESPONSES
201
A session has successfully been started on a machine in the provided location.
object
hoststring
The IP address of the machine that the session is running on.
ports
object[]
The list of mapped ports for this session.
401
You are not authorized to start a session. Please make sure that the included bearer
token is correct.
404
The request contains a location, image or organization that does not exist.
409
Cannot start a session with the provided id. Please use a unique identifier
for your session. It is recommended to use a UUID.
420
This session can not be started in the provided location currently. This could also be
the result of starting too many sessions in a short period of time. 
Please try again later!
422
Bad request. This may imply that the given request has invalid syntax.
﻿
﻿
Updated 03 Mar 2023
Did this page help you?
Yes
UP NEXT
Lists a collection of active sessions.
Docs powered by archbee