Skip to main content
Version: 5.8.0

SysLaunchServer

Launch a hosted server directly. Allows for the bypassing of brainCloud lobby matchmaking.

ServiceOperation
roomServerLAUNCH_SERVER

Method Parameters

ParameterDescription
serverNameThe type of server to launch as defined in App > Design > Servers > My Servers .
scriptNameThe name of the cloud code script to invoke for all hosted server launch events. Should be the whole path to the script.
scriptDataOptional JSON object that will be sent as input to the associated cloud code script.
regionIdOptional region id to target for the hosted server launch.

Usage

http://localhost:3000
// Cloud Code only. To view example, switch to the Cloud Code tab
JSON Response
{
"data": {
"serverId": "23782:d1787dee-7a3a-42e1-a2ae-74e08ca507f5"
},
"status": 200
}