Game server API calls

This page describes all the API calls you can make to get information and control your game 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 
getAllTitles

Get all available game titles


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
titlesarrayList of all game titles
gameIdtitlesintThe game's ID
gameNametitlesstringThe game's name
minSlotstitlesintMinimum slots
maxSlotstitlesintMaximum slots
publicPricingtitlesintPublic host pricing, per slot
privatePricingtitlesintPrivate host pricing, per slot
onlyPublictitlesintOnly public host (0 or 1)
tickRatestitlesarrayAll available tickrates (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [titles] => Array
                (
                    [0] => Array
                        (
                            [gameId] => 1
                            [gameName] => Unreal Tournament (GotY/99)
                            [minSlots] => 2
                            [maxSlots] => 64
                            [publicPricing] => 99
                            [privtePricing] => 75
                            [onlyPublic] => 0
                            [tickRates] => Array
                                (
                                    [0] => 30
                                    [1] => 60
                                )

                        )

                    [1] => Array
                        (
                            [gameId] => 2
                            [gameName] => Tactical Ops: Assault on Terror 3.4
                            [minSlots] => 2
                            [maxSlots] => 64
                            [publicPricing] => 99
                            [privtePricing] => 75
                            [onlyPublic] => 0
                        )

                )

        )

)
POST 
getAll

Get all game servers assigned to your account


Request parameters
ParameterContextTypeDescription
rangeStartintStart index of the range you want to receive. Default is 0.
rangeLengthintThe number of rows you want to recieve. Default is 10000.
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
liveSessionDatagameserversstringLive session data of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
stopGameExistsgameserversboolIs the gameserver forced stopped.
stopAutoRestartExistsgameserversboolIs the auto restart enabled or disabled.
tickRategameserversintTickrate for this server. (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [liveSessionData] => 
                            [locationId] => 18
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [stopGameExists] => 0
                            [stopAutoRestartExists] => 0
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                            [tickRate] => 60
                        )

                )

        )

)
POST 
getAllEmpty

Get all empty game servers that are online


Request parameters
ParameterContextTypeDescription
rangeStartintStart index of the range you want to receive. Default is 0.
rangeLengthintThe number of rows you want to recieve. Default is 1.
gameIdintThe ID of the game.
locationIdintThe ID of the location.
markAsUsedintSet the total active players to maximum for the fetched selection. Default: 0. 1 = true, 0 = false
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
liveSessionDatagameserversstringLive session data of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
stopGameExistsgameserversboolIs the gameserver forced stopped.
stopAutoRestartExistsgameserversboolIs the auto restart enabled or disabled.
tickRategameserversintTickrate for this server. (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [liveSessionData] => 
                            [locationId] => 18
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [stopGameExists] => 0
                            [stopAutoRestartExists] => 0
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                            [tickRate] => 60
                        )

                )

        )

)
POST 
getAllBad

Get all game servers in a bad state, assigned to your account


Extra information:

Game servers are considered to be in a bad state if their cpu usage is 99% or more and no players are connected.

Request parameters
ParameterContextTypeDescription
rangeStartintStart index of the range you want to receive. Default is 0.
rangeLengthintThe number of rows you want to recieve. Default is 10000.
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
liveSessionDatagameserversstringLive session data of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
usageDiskgameserversintHard disk usage
stopGameExistsgameserversboolIs the gameserver forced stopped.
stopAutoRestartExistsgameserversboolIs the auto restart enabled or disabled.
tickRategameserversintTickrate for this server. (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [liveSessionData] => 
                            [locationId] => 18
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [stopGameExists] => 0
                            [stopAutoRestartExists] => 0
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                            [tickRate] => 60
                        )

                )

        )

)
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 
getTotals

Get the sums of game servers, slots and live player count


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
totalsarrayContainer for the summaries
numServerstotalsintNumber of game servers in your account
numSlotstotalsintTotal number of game server slots
numPlayerstotalsintNumber of players on all your game servers

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [totals] => Array
                (
                    [0] => Array
                        (
                            [numServers] => 0
                            [numSlots] => 0
                            [numPlayers] => 0
                        )

                )

        )

)
POST 
getServersByServerId

Get all game servers running on a physical server


Request parameters
ParameterContextTypeDescription
serverIdintID of the physical server
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
liveSessionDatagameserversstringLive session data of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
usageDiskgameserversintHard disk usage
stopGameExistsgameserversboolIs the gameserver forced stopped.
stopAutoRestartExistsgameserversboolIs the auto restart enabled or disabled.
tickRategameserversintTickrate for this server. (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [liveSessionData] => 
                            [locationId] => 18
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [stopGameExists] => 0
                            [stopAutoRestartExists] => 0
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                            [tickRate] => 60
                        )

                )

        )

)
POST 
getServersByGameId

Get all your game servers of a certain game


Request parameters
ParameterContextTypeDescription
gameIdintID of the game
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
liveSessionDatagameserversstringLive session data of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
usageDiskgameserversintHard disk usage
stopGameExistsgameserversboolIs the gameserver forced stopped.
stopAutoRestartExistsgameserversboolIs the auto restart enabled or disabled.
tickRategameserversintTickrate for this server. (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [liveSessionData] => 
                            [locationId] => 18
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [stopGameExists] => 0
                            [stopAutoRestartExists] => 0
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                            [tickRate] => 60
                        )

                )

        )

)
POST 
getServerById

Get a game server by ID


IMPORTANT NOTICE: you are limited to 50 graph requests per minute.


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
incGraphint(optional) Include usage graph image data if 1.
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
liveSessionDatagameserversstringLive session data of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
usageDiskgameserversintHard disk usage
usageGraphsgameserversarrayUsage graphs
graphDayusageGraphsbase64encodedUsage graph of the last 24 hours
graphWeekusageGraphsbase64encodedUsage graph of the last week
graphMonthusageGraphsbase64encodedUsage graph of the last month
stopGameExistsgameserversboolIs the gameserver forced stopped.
stopAutoRestartExistsgameserversboolIs the auto restart enabled or disabled.
tickRategameserversintTickrate for this server. (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [liveSessionData] => 
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [stopGameExists] => 0
                            [stopAutoRestartExists] => 0
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                            [tickRate] => 60
                        )

                )

        )

)
POST 
getServersByIp

Get all your game servers by IP address. Optionally supply game, admin and / or query port


IMPORTANT NOTICE: you are limited to 50 graph requests per minute.


Request parameters
ParameterContextTypeDescription
ipstringIP address of the game server
gamePortintGame port of the game server (optional)
adminPortintAdmin port of the game server (optional)
queryPortintQuery port of the game server (optional)
incGraphint(optional) Include usage graph image data if 1.
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
liveSessionDatagameserversstringLive session data of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
usageDiskgameserversintHard disk usage
stopGameExistsgameserversboolIs the gameserver forced stopped.
stopAutoRestartExistsgameserversboolIs the auto restart enabled or disabled.
tickRategameserversintTickrate for this server. (optional)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [liveSessionData] => 
                            [locationId] => 18
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [stopGameExists] => 0
                            [stopAutoRestartExists] => 0
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                            [tickRate] => 60
                        )

                )

        )

)
POST 
getUsageGraphs

Get daily, weekly and monthly usage graphs


IMPORTANT NOTICE: you are limited to 50 graph requests per minute.


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server.
Response parameters
ParameterContextTypeDescription
usageGraphsarrayList of game servers
graphDayusageGraphsbase64encodedUsage graph of the last 24 hours
graphWeekusageGraphsbase64encodedUsage graph of the last week
graphMonthusageGraphsbase64encodedUsage graph of the last month

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [usageGraphs] => Array
                (
                    [0] => Array
                        (
                            [graphDay] => base64encoded image data (image/png)
                            [graphWeek] => base64encoded image data (image/png)
                            [graphMonth] => base64encoded image data (image/png)
                        )

                )

        )

)
POST 
getLiveInfo

Get live game server information (slow query)


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
liveInfoarrayContainer for live information
ipliveInfostringIP of the game server
portliveInfointGame port of the server
hostnameliveInfostringGame server name
mapliveInfostringName of the currently selected map
numPlayersliveInfointLive player count
maxPlayersliveInfointMaximum number of slots
pingliveInfostringLatency

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [liveInfo] => Array
                (
                    [ip] => 
                    [port] => 
                    [hostname] => 
                    [map] => 
                    [numPlayers] => 
                    [maxPlayers] => 
                    [ping] => 
                )

        )

)
POST 
getLiveInfoAll

Get live information from all game servers (slow query)


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
gameserversarrayList of game servers
serverIdgameserversintId of the physical server
isVirtualgameserversintDeployed on a 0: bare metal server, 1: virtual server
gameserverIdgameserversintID of the game server
dedicatedIdgameserversintID of the dedicated server.
Returned only if you are the dedicated server owner
serverNamegameserversstringName of the physical server
physicalLiveHostnamegameserversstringLive host name of the physical server - Only for premium users
i3dMonitorVersiongameserversstringi3D.net Monitor version string - Only for premium users
i3dServerMonitorVersiongameserversstringi3D.net Server Monitor version string - Only for premium users
gameIdgameserversintID of the game title
gameNamegameserversstringGame title
ipgameserversstringGame server IP
portgameserversintGame server network port
queryPortgameserversintGame server query port
hostNamegameserversstringName of the game server
locationIdgameserversintLocation ID of the server
locationgameserversstringLocation of the server
locationFullgameserversstringFull location name of the server
serviceParametersgameserversstringStartup string
networkSecondaryIpgameserversstringSecondary IP of the gameserver
livePlayersgameserversintNumber of players on the host
maxPlayersgameserversintMaximum slots
onlinegameserversint/stringOnline = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnlinegameserversintLast online time in timestamp format
liveVersiongameserversstringVersion string of the running game
gameVersiongameserversstringVersion string of the installed game
liveMapgameserversstringLive map of the running game
uptimegameserversintUptime in seconds
rulesgameserversarrayArray of game server rules (configuration)
usageCpugameserversintCPU usage
usageMemorygameserversintMemory usage
usageDiskgameserversintHard disk usage

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 72632
                            [isVirtual] => 0
                            [gameserverId] => 234694
                            [dedicatedId] => 31734
                            [serverName] => Server 3523
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 213.163.78.133
                            [port] => 10000
                            [queryPort] => 15001
                            [hostName] => 
                            [locationId] => 18
                            [location] => ams
                            [locationFull] => EU: Rotterdam
                            [serviceParameters] => 
                            [networkSecondaryIp] => 
                            [livePlayers] => 0
                            [maxPlayers] => 0
                            [online] => 0
                            [lastOnline] => 1442302246
                            [liveVersion] => 
                            [gameVersion] => 
                            [liveMap] => 
                            [uptime] => 0
                            [rules] => Array
                                (
                                )

                            [usageCpu] => 0
                            [usageMemory] => 0
                            [usageDisk] => 0
                        )

                )

        )

)
POST 
getCrashCount

Get crash amount by game ID.


Request parameters
ParameterContextTypeDescription
gameIdintId of the game
Response parameters
ParameterContextTypeDescription
crashesintThe amount of game crashes

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [crashes] => Array
                (
                    [0] => 2
                )

        )

)
POST 
getCrashesByServer

Get all crash statistics by gameserver ID


Request parameters
ParameterContextTypeDescription
gameIdintId of the game.
limitint(optional) Limit the amount of crashes to retreive, maximum and default is 75000.
offsetint(optional) Offset from where to start retreiving the amount of crashes, will return 0 if offset is larger than amount of crashes.
Response parameters
ParameterContextTypeDescription
crashIdintThe ID of the crash
gameIdintThe ID of the game
gameserverIdintThe ID of the gameserver
serverIdintThe ID of the server
MapNamestringThe name of the map
gameModestringThe game mode
livePlayersintAmount of live players
liveVersionstringLive version
userNotestringNotes
CrashTimeintTime of the crash

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [crashes] => Array
                (
                    [crashId] => 2100981
                    [gameId] => 358
                    [gameserverId] => 260110
                    [serverId] => 13531
                    [MapName] => MP_012
                    [gameMode] => ConquestSmall
                    [livePlayers] => 0
                    [liveVersion] => 
                    [userNote] => 
                    [CrashTime] => 1433391272
                )

        )

)

Control

POST 
start

Start game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
startarrayContainer for result
instructionSentstartint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [start] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
restart

Restart game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
restartarrayContainer for result
instructionSentrestartint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [restart] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
softRestart

Restart game server using the soft restart method


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
secondsint(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server
Response parameters
ParameterContextTypeDescription
restartarrayContainer for result
instructionSentrestartint1
msgrestartstringA human readable result message

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [restart] => Array
                (
                    [instructionSent] => 1
                    [msg] => The game server restart command has been queued.
                )

        )

)
POST 
hardRestart

Restart game server using the hard restart method


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
secondsint(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server
Response parameters
ParameterContextTypeDescription
restartarrayContainer for result
instructionSentrestartint1
msgrestartstringA human readable result message

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [restart] => Array
                (
                    [instructionSent] => 1
                    [msg] => The gameserver will be restarted in about a minute
                )

        )

)
POST 
restartByIp

Restart game server(s) by IP


Request parameters
ParameterContextTypeDescription
serversarrayArray with multiple server ip and port
ipstringIP address of the game server
portintGame port of the game server (optional)
Response parameters
ParameterContextTypeDescription
restartarrayContainer for result
instructionSentrestartint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [restart] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
stop

Stop game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
stoparrayContainer for result
instructionSentstopint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [stop] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
softStop

Stop gameserver using the soft stop method.


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
secondsint(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server
Response parameters
ParameterContextTypeDescription
stoparrayContainer for result
instructionSentstopint1
msgstopstringA human readable result message

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [stop] => Array
                (
                    [instructionSent] => 1
                    [msg] => The game server stop command has been queued.
                )

        )

)
POST 
hardStop

Stop gameserver using the hard stop method


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
secondsint(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server
Response parameters
ParameterContextTypeDescription
stoparrayContainer for result
instructionSentstopint1
msgstopstringA human readable result message

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [stop] => Array
                (
                    [instructionSent] => 1
                    [msg] => The game server will be stopped in about a minute.
                )

        )

)
POST 
executeActionMethod

Execute an action method


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
methodIdintID the action method
secondsint(optional) shutdown in maximum amount of seconds
Response parameters
ParameterContextTypeDescription
executeActionMethodarrayContainer for result
instructionSentexecuteActionMethodint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [executeActionMethod] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
getAllActionMethods

Get all available action methods for this game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
methodsarrayContainer for result

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 1
                    [name] => Default restart game server
                    [menuTitle] => Force to restart
                    [tooltip] => This will force the server to restart
                    [description] => This the default restart game server method. There will be a file "restart_game" placed in the gameserver directory. And our software will detect this and restart the gameserver.
                    [type] => Array
                        (
                            [id] => 1
                            [name] => restart
                            [classificationName] => hard
                        )

                )

        )

)
POST 
enableAutoRestart

Enable auto restart for the game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
startarrayContainer for result
instructionSentenableAutoRestartint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [enableAutoRestart] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
disableAutoRestart

Disable auto restart for the game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
startarrayContainer for result
instructionSentdisableAutoRestartint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [enableAutoRestart] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
getConfig

Get a configuration file


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
gameconfigNamestringName of the configuration file you want to retrieve
Response parameters
ParameterContextTypeDescription
configarrayContainer for the result
gameconfigIdconfigintID of this configuration file
gameconfigconfigstringThe contents of the config file
gameconfigCanEditconfigstringWhether you can update this config (0 or 1)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [config] => Array
                (
                    [gameconfigId] => 1234
                    [gameconfig] => [config text]
                    [gameconfigCanEdit] => 1
                )

        )

)
POST 
updateConfig

Update a configuration file


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
gameconfigNamestringName of the configuration file you want to update
gameconfigstringThe contents of the configuration file, base64 encoded
restart (optional)intIf 1, the game server will be restarted after config update
Response parameters
ParameterContextTypeDescription
updateConfigarrayContainer for the result
resultupdateConfigstringThe result string

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [config] => Array
                (
                    [gameconfigId] => 1234
                    [gameconfig] => [config text]
                    [gameconfigCanEdit] => 1
                )

        )

)
POST 
setLiveState

Set the live state for the game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
liveStateintThe live state of the game server
Response parameters
ParameterContextTypeDescription
setLiveStatearrayContainer for result
resultsetLiveStateint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [setLiveState] => Array
                (
                    [result] => 1
                )

        )

)
POST 
setLiveSessionData

Set the live session data for the game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
liveSessionDatastringThe live session data of the game server
Response parameters
ParameterContextTypeDescription
setLiveSessionDataarrayContainer for result
resultsetLiveSessionDataint1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [setLiveSessionData] => Array
                (
                    [result] => 1
                )

        )

)

Install

POST 
getAvailableInstalls

Get available software installs / updates for a game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
Response parameters
ParameterContextTypeDescription
installsarrayContainer for result
installIdinstallsintID of the install / update
nameinstallsintName of the install / update
versioninstallsintVersion string
isupdateinstallsintIs it an update or full install (1 or 0)

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [installs] => Array
                (
                    [0] => Array
                        (
                            [installId] => 1135
                            [name] => BFBC2 R34
                            [version] => 1308106
                            [isupdate] => 0
                        )

                )

        )

)
POST 
install

Install an update for a game server


Request parameters
ParameterContextTypeDescription
gameserverIdintID of the game server
installIdintID of the software install / update
Response parameters
ParameterContextTypeDescription
installarrayContainer for result
instructionSentinstallint0 or 1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [install] => Array
                (
                    [0] => Array
                        (
                            [instructionSent] => 1
                        )

                )

        )

)