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
| Parameter | Context | Type | Description |
|---|---|---|---|
| gameId | int | Id of the game | parameters | array | (optional) Additional parameters | locationId | parameters | int | (optional) First setup variables | sortBy | parameters | int | (optional) Sort type by 1=id, 2=ip, 3=name | batch | parameters | int | (optional) Limit values | memory | parameters | int | (optional) Memory needed for server | hddSpace | parameters | int | (optional) Minimal free space on the server in GB | instanceCount | parameters | string | (optional) Active instances, "none" = servers without an instance count | ip | parameters | int | (optional) Search by 0 = public 1 = private IP |
| Parameter | Context | Type | Description |
|---|---|---|---|
| serverId | int | The ID of the server | shortName | string | The shortname of the server | serverName | string | The name of the server | gameId | int | The game's ID | gameName | string | The game's name | locationName | string | Location of the server | cpuLoad | int | Percentage of CPU usage | hddSpace | int | Total available drive space | freeRam | int | Free memory in MB | slots | int | Number of slots in use | instances | int | Number of instances | ranking | int | Ranking | ipList | array | List of ip's |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[servers] => Array
(
[0] => Array
(
[serverId] => _ID_
[shortName] => ams
[serverName] => _SERVER-NAME_
[gameId] => 152
[gameName] => Minecraft
[locationName] => EU: Rotterdam
[cpuLoad] => 0
[hddSpace] => 512
[freeRam] => 2048
[slots] => 8000
[instances] => 700
[ranking] => 4
[ipList] => Array
(
[0] => 203.0.113.2
)
)
[1] => Array
(
[serverId] => _ID_
[shortName] => ams
[serverName] => _SERVER-NAME_
[gameId] => 152
[gameName] => Minecraft
[locationName] => EU: Rotterdam
[cpuLoad] => 0
[hddSpace] => 512
[freeRam] => 2048
[slots] => 8000
[instances] => 1244
[ranking] => 4
[ipList] => Array
(
[0] => 203.0.113.2
[1] => 2001:db8::13::48
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| task | int | The ID of the task |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[tasks] => Array
(
[taskIds] => Array
(
[0] => 12
[1] => 13
[2] => 14
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | Id of the task |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskType | string | Type of task | progress | float | Percentage completed | totalActions | int | Total actions | performedActions | int | Action in progress | actionsToProgress | int | Action in progress | totalGameservers | int | Total count of game servers | completedGameservers | int | Count of completed game server(s) | failedGameservers | int | Count of failed game server(s) | status | int | Step being currently taken | errorCode | string | Error code | retries | int | Amount of retries | report | array | task 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
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| gameId | int | The ID of the game | gamename | string | The 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
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| gameId | int | Id of the game |
| Parameter | Context | Type | Description |
|---|---|---|---|
| game | array | Returned game | gameId | game | int | ID of the game | gameName | game | string | Name of the game | installId | game | int | ID of the install | version | game | string | Instal 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
| Parameter | Context | Type | Description |
|---|---|---|---|
| gameId | int | Id of the game | parameters | array | Additional parameters | sid | parameters | array | Select array of server ids to deploy to | gsPort | parameters | int | (optional) Game server port | public | parameters | int | (optional) Set 1=public, 2=private | gsPassword | parameters | int | (optional) Game server password | deployCount | parameters | int | (optional) Amount of deploys | slots | parameters | int | (optional) Amount of slots in each server | multiInstance | parameters | int | (optional) Set as multi instance deploy | portOffset | parameters | int | (optional) Distance between each port on the game server | queryPort | parameters | int | (optional) Query port for each game server | adminPort | parameters | int | (optional) Admin port for each game server | debugPort | parameters | int | (optional) Debug port for each game server | notifyPort | parameters | int | (optional) Notify port for each game server | requestPort | parameters | int | (optional) Request port for each game server | platformId | parameters | int | (optional) Platform to deploy on | installId | parameters | int | (optional) Instal id of the installation to instal on the game servers |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | The ID of the task | overview | array | overview of game server for the task | serverId | overview | int | The ID of the server | serverName | overview | string | The name of the server | ipAddresses | overview | array | List of ip's | gameserverId | overview | int | ID of the game server | gameName | overview | string | The game's name | deployIp | overview | string | the IP where deployed | shortName | overview | string | The shortname of the server | public | overview | int | 1=public, 2=private | slots | overview | int | Number of slots in use | platformId | overview | int | ID of the platform 1=PC, 2=Xbox360, 3= PS3 | queryport | overview | int | Port of the query | gsport | overview | int | Port of the game server | portoffset | overview | int | Offset of the port |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[deploy] => Array
(
[taskId] => 126
[overview] => Array
(
[serverId] => _ID_
[serverName] => _SERVER-NAME_
[ipAddresses] => Array
(
[0] => 203.0.113.2
[1] => 2001:db8::13::48
)
[gameserverId] => _ID_
[gameName] => Minecraft
[deployIp] => 203.0.113.2
[shortName] => ams
[public] => 1
[slots] => 8000
[platformId] => 1
[queryport] => 0
[gsport] => 29400
[portoffset] => 10
)
)
)
)
Control
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | array of game servers | gameservers | parameters | array | Select array of game server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 817
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Array of game servers | gameservers | parameters | array | Select array of gameserver |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 987
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Array of game servers | gameservers | parameters | array | Select array of gameserver |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 817
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Array of game servers | gameservers | parameters | array | Select array of game server | maxSlots | parameters | int | maximum slots |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 817
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Array of game servers | gameservers | parameters | array | Select array of game server | startParam | parameters | string | start line parameters |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 312
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Array of game servers | gameservers | parameters | array | Select array of game servers | newGameId | parameters | int | ID of the new game | immediateInstall | parameters | int | (optional) Install immediately |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 972
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Array of game servers | gameservers | parameters | array | Select array of game servers | instalId | parameters | int | ID of the install to perform | mode | parameters | int | (optional) update modes |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 312
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Array of game servers | gameservers | parameters | array | Select array of game servers |
| Parameter | Context | Type | Description |
|---|---|---|---|
| taskId | int | ID of the task created |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[taskId] => 563
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| parameters | array | Parameters required for this action. | gameservers | parameters | array | Array of game server IDs. | restartI3dMonitor | parameters | bool | Whether to also restart the i3D Monitor. Defaults to false. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| resultIds | array | Successfully queued game server actions | gameserverId | int | Game server ID | actionId | int | Action ID | failIds | array | Game server IDs whose action failed to be queued. |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[taskId] => Array
(
[resultIds] => Array
(
[0] => Array
(
[gameserverId] => _ID_
[actionId] => _ID_
)
[1] => Array
(
[gameserverId] => _ID_
[actionId] => _ID_
)
)
[failIds] => Array
(
)
)
)
)