Bulk actions API calls

This page describes all the API calls you can make to view and perform bulk actions to your server(s).
You will always receive the output as described in the documentation below unless an error ocurred. For more information, see the error handling section.

Actions

POST 
getServersForDeploy

Get game server for deployment by game ID.


Request parameters
ParameterContextTypeDescription
gameIdintId of the game
parametersarray(optional) Additional parameters
locationIdparametersint(optional) First setup variables
sortByparametersint(optional) Sort type by 1=id, 2=ip, 3=name
batchparametersint(optional) Limit values
memoryparametersint(optional) Memory needed for server
hddSpaceparametersint(optional) Minimal free space on the server in GB
instanceCountparametersstring(optional) Active instances, "none" = servers without an instance count
ipparametersint(optional) Search by 0 = public 1 = private IP
Response parameters
ParameterContextTypeDescription
serverIdintThe ID of the server
shortNamestringThe shortname of the server
serverNamestringThe name of the server
gameIdintThe game's ID
gameNamestringThe game's name
locationNamestringLocation of the server
cpuLoadintPercentage of CPU usage
hddSpaceintTotal available drive space
freeRamintFree memory in MB
slotsintNumber of slots in use
instancesintNumber of instances
rankingintRanking
ipListarrayList of ip's

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [servers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 13450
                            [shortName] => ams
                            [serverName] => Server 3523
                            [gameId] => 152
                            [gameName] => Minecraft
                            [locationName] => EU: Rotterdam
                            [cpuLoad] => 0
                            [hddSpace] => 512
                            [freeRam] => 2048
                            [slots] => 8000
                            [instances] => 700
                            [ranking] => 4
                            [ipList] => Array
                                (
                                    [0] => 213.163.78.133
                                )

                        )

                    [1] => Array
                        (
                            [serverId] => 18418
                            [shortName] => ams
                            [serverName] => Server 3523
                            [gameId] => 152
                            [gameName] => Minecraft
                            [locationName] => EU: Rotterdam
                            [cpuLoad] => 0
                            [hddSpace] => 512
                            [freeRam] => 2048
                            [slots] => 8000
                            [instances] => 1244
                            [ranking] => 4
                            [ipList] => Array
                                (
                                    [0] => 213.163.78.134
                                    [1] => 2a00:1630:13::48
                                    [2] => 2a00:1630:1:4::
                                )

                        )

                )

        )

)
POST 
getTaskIds

Get task IDs.


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
taskintThe ID of the task

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [tasks] => Array
                (
                    [taskIds] => Array
                        (
                            [0] => 12
                            [1] => 13
                            [2] => 14
                        )

                )

        )

)
POST 
getTaskStatus

Get task status by task ID.


Request parameters
ParameterContextTypeDescription
taskIdintId of the task
Response parameters
ParameterContextTypeDescription
taskTypestringType of task
progressfloatPercentage completed
totalActionsintTotal actions
performedActionsintAction in progress
actionsToProgressintAction in progress
totalGameserversintTotal count of game servers
completedGameserversintCount of completed game server(s)
failedGameserversintCount of failed game server(s)
statusintStep being currently taken
errorCodestringError code
retriesintAmount of retries
reportarraytask history

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskstatus] => Array
                (
                    [taskStatus] => Array
                        (
                            [taskType] => deploy
                            [progress] => 10
                            [totalActions] => 50
                            [performedActions] => 5
                            [actionInProgress] => 45
                            [total] => 9
                            [status] => JOB_DEPLOY_BUSY
                            [errorCode] => 0
                            [retries] => 0
                            [report] => Array
                                (
                                    [0] => gameserver 142011 started install
                                    [1] => gameserver 142011 ftp is working
                                    [2] => gameserver 142011 started ftp check
                                    [3] => gameserver 142011 finished startline action
                                    [4] => gameserver 142011 started startline action
                                    [5] => gameserver 142011 finished ftp action
                                    [6] => starting deploy
                                    [7] => started job
                                )

                        )

                )

        )

)
POST 
getAllGameIds

Get all game IDs assigned to your account.


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
gameIdintThe ID of the game
gamenamestringThe ID of the game

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [games] => Array
                (
                    [0] => Array
                        (
                            [0] => 1
                            [1] => Unreal Tournament (GotY/99)
                        )

                    [1] => Array
                        (
                            [0] => 2
                            [1] => Tactical Ops: Assault on Terror 3.4
                        )

                    [2] => Array
                        (
                            [0] => 252
                            [1] => Minecraft
                        )

                )

        )

)
POST 
getAllInstalls

Get all installs by game ID.


Request parameters
ParameterContextTypeDescription
gameIdintId of the game
Response parameters
ParameterContextTypeDescription
gamearrayReturned game
gameIdgameintID of the game
gameNamegamestringName of the game
installIdgameintID of the install
versiongamestringInstal Version

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [installs] => Array
                (
                    [0] => Array
                        (
                            [gameId] => 104
                            [gameName] => cod4linux
                            [installId] => 186
                            [version] => 1.0
                        )

                    [1] => Array
                        (
                            [gameId] => 104
                            [gameName] => cod4 1.3
                            [installId] => 187
                            [version] => 1.0
                        )

                )

        )

)

Deploy

POST 
deployByGameId

Deploy on server(s) by game ID.


Request parameters
ParameterContextTypeDescription
gameIdintId of the game
parametersarrayAdditional parameters
sidparameters arraySelect array of server ids to deploy to
gsPortparametersint(optional) Game server port
publicparametersint(optional) Set 1=public, 2=private
gsPasswordparametersint(optional) Game server password
deployCountparametersint(optional) Amount of deploys
slotsparametersint(optional) Amount of slots in each server
multiInstanceparametersint(optional) Set as multi instance deploy
portOffsetparametersint(optional) Distance between each port on the game server
queryPortparametersint(optional) Query port for each game server
adminPortparametersint(optional) Admin port for each game server
debugPortparametersint(optional) Debug port for each game server
notifyPortparametersint(optional) Notify port for each game server
requestPortparametersint(optional) Request port for each game server
platformIdparametersint(optional) Platform to deploy on
installIdparametersint(optional) Instal id of the installation to instal on the game servers
Response parameters
ParameterContextTypeDescription
taskIdintThe ID of the task
overviewarrayoverview of game server for the task
serverIdoverviewintThe ID of the server
serverNameoverviewstringThe name of the server
ipAddressesoverviewarrayList of ip's
gameserverIdoverviewintID of the game server
gameNameoverviewstringThe game's name
deployIpoverviewstringthe IP where deployed
shortNameoverviewstringThe shortname of the server
publicoverviewint1=public, 2=private
slotsoverviewintNumber of slots in use
platformIdoverviewintID of the platform 1=PC, 2=Xbox360, 3= PS3
queryportoverviewintPort of the query
gsportoverviewintPort of the game server
portoffsetoverviewintOffset of the port

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [deploy] => Array
                (
                    [taskId] => 126
                    [overview] => Array
                        (
                            [serverId] => 17455
                            [serverName] => Server 3523
                            [ipAddresses] => Array
                                (
                                    [0] => 213.163.78.133
                                    [1] => 213.163.78.134
                                    [2] => 2a00:1630:13::48
                                    [3] => 2a00:1630:1:4::
                                )

                            [gameserverId] => 367800
                            [gameName] => Minecraft
                            [deployIp] => 213.163.78.133
                            [shortName] => ams
                            [public] => 1
                            [slots] => 8000
                            [platformId] => 1
                            [queryport] => 0
                            [gsport] => 29400
                            [portoffset] => 10
                        )

                )

        )

)

Control

POST 
startGameservers

Start game servers given by an array of game server IDs


Request parameters
ParameterContextTypeDescription
parametersarrayarray of game servers
gameserversparametersarraySelect array of game server
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 817
                )

        )

)
POST 
stopGameservers

Stop game servers given by an array of game server IDs


Request parameters
ParameterContextTypeDescription
parametersarrayArray of game servers
gameserversparametersarraySelect array of gameserver
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 987
                )

        )

)
POST 
steamUpdate

Steam update the game servers given by an array of game server IDs


Request parameters
ParameterContextTypeDescription
parametersarrayArray of game servers
gameserversparametersarraySelect array of gameserver
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 817
                )

        )

)
POST 
setMaxSlots

Set max slots to game servers by an array of game server IDs


Request parameters
ParameterContextTypeDescription
parametersarrayArray of game servers
gameserversparametersarraySelect array of game server
maxSlotsparametersintmaximum slots
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 817
                )

        )

)
POST 
setStartline

Set the start line parameters for game servers


Request parameters
ParameterContextTypeDescription
parametersarrayArray of game servers
gameserversparametersarraySelect array of game server
startParamparametersstringstart line parameters
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 312
                )

        )

)
POST 
switchGame

Switch game on selected game servers


Request parameters
ParameterContextTypeDescription
parametersarrayArray of game servers
gameserversparametersarraySelect array of game servers
newGameIdparametersintID of the new game
immediateInstallparametersint(optional) Install immediately
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 972
                )

        )

)
POST 
softwareInstall

Game installs to game servers by an array of game server IDs


Request parameters
ParameterContextTypeDescription
parametersarrayArray of game servers
gameserversparametersarraySelect array of game servers
instalIdparametersintID of the install to perform
modeparametersint(optional) update modes
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 312
                )

        )

)
POST 
preloadInstall

Preload install for game servers by an array of game server IDs


Request parameters
ParameterContextTypeDescription
parametersarrayArray of game servers
gameserversparametersarraySelect array of game servers
Response parameters
ParameterContextTypeDescription
taskIdintID of the task created

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [taskId] => 563
                )

        )

)
POST 
restoreParameters

Restore startup scripts for an array of game server IDs


Request parameters
ParameterContextTypeDescription
parametersarrayParameters required for this action.
gameserversparametersarrayArray of game server IDs.
restartI3dMonitorparametersboolWhether to also restart the i3D Monitor. Defaults to false.
Response parameters
ParameterContextTypeDescription
resultIdsarraySuccessfully queued game server actions
gameserverIdintGame server ID
actionIdintAction ID
failIdsarrayGame server IDs whose action failed to be queued.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [taskId] => Array
                (
                    [resultIds] => Array
                        (
                            [0] => Array
                                (
                                    [gameserverId] => 367152
                                    [actionId] => 2534424
                                )

                            [1] => Array
                                (
                                    [gameserverId] => 367153
                                    [actionId] => 2534425
                                )

                        )

                    [failIds] => Array
                        (
                        )

                )

        )

)