i3D.net API Documentation

POST

getAllTitles

Get all available game titles

Request parameters

Parameter	Context	Type	Description
No parameters

Response parameters

Parameter	Context	Type	Description
titles		array	List of all game titles
gameId	titles	int	The game's ID
gameName	titles	string	The game's name
minSlots	titles	int	Minimum slots
maxSlots	titles	int	Maximum slots
publicPricing	titles	int	Public host pricing, per slot
privatePricing	titles	int	Private host pricing, per slot
onlyPublic	titles	int	Only public host (0 or 1)
tickRates	titles	array	All 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

details

Request parameters

Parameter	Context	Type	Description
rangeStart		int	Start index of the range you want to receive. Default is 0.
rangeLength		int	The number of rows you want to recieve. Default is 10000.

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
liveSessionData	gameservers	string	Live session data of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
stopGameExists	gameservers	bool	Is the gameserver forced stopped.
stopAutoRestartExists	gameservers	bool	Is the auto restart enabled or disabled.
tickRate	gameservers	int	Tickrate for this server. (optional)

Example

POST

getAllEmpty

Get all empty game servers that are online

details

Request parameters

Parameter	Type	Description
rangeStart	int	Start index of the range you want to receive. Default is 0.
rangeLength	int	The number of rows you want to recieve. Default is 1.
gameId	int	The ID of the game.
locationId	int	The ID of the location.
markAsUsed	int	Set the total active players to maximum for the fetched selection. Default: 0. 1 = true, 0 = false

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
liveSessionData	gameservers	string	Live session data of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
stopGameExists	gameservers	bool	Is the gameserver forced stopped.
stopAutoRestartExists	gameservers	bool	Is the auto restart enabled or disabled.
tickRate	gameservers	int	Tickrate for this server. (optional)

Example

POST

getAllBad

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

details

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

Parameter	Context	Type	Description
rangeStart		int	Start index of the range you want to receive. Default is 0.
rangeLength		int	The number of rows you want to recieve. Default is 10000.

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
liveSessionData	gameservers	string	Live session data of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
usageDisk	gameservers	int	Hard disk usage
stopGameExists	gameservers	bool	Is the gameserver forced stopped.
stopAutoRestartExists	gameservers	bool	Is the auto restart enabled or disabled.
tickRate	gameservers	int	Tickrate for this server. (optional)

Example

POST

getAllGameIds

Get all game IDs assigned to your account

details

Request parameters

Parameter	Context	Type	Description
No parameters

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

                )

        )

)

POST

getTotals

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

details

Request parameters

Parameter	Context	Type	Description
No parameters

Response parameters

Parameter	Context	Type	Description
totals		array	Container for the summaries
numServers	totals	int	Number of game servers in your account
numSlots	totals	int	Total number of game server slots
numPlayers	totals	int	Number 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

details

Request parameters

Parameter	Context	Type	Description
serverId		int	ID of the physical server

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
liveSessionData	gameservers	string	Live session data of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
usageDisk	gameservers	int	Hard disk usage
stopGameExists	gameservers	bool	Is the gameserver forced stopped.
stopAutoRestartExists	gameservers	bool	Is the auto restart enabled or disabled.
tickRate	gameservers	int	Tickrate for this server. (optional)

Example

POST

getServersByGameId

Get all your game servers of a certain game

details

Request parameters

Parameter	Context	Type	Description
gameId		int	ID of the game

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
liveSessionData	gameservers	string	Live session data of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
usageDisk	gameservers	int	Hard disk usage
stopGameExists	gameservers	bool	Is the gameserver forced stopped.
stopAutoRestartExists	gameservers	bool	Is the auto restart enabled or disabled.
tickRate	gameservers	int	Tickrate for this server. (optional)

Example

POST

getServerById

Get a game server by ID

details

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

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
incGraph		int	(optional) Include usage graph image data if 1.

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
liveSessionData	gameservers	string	Live session data of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
usageDisk	gameservers	int	Hard disk usage
usageGraphs	gameservers	array	Usage graphs
graphDay	usageGraphs	base64encoded	Usage graph of the last 24 hours
graphWeek	usageGraphs	base64encoded	Usage graph of the last week
graphMonth	usageGraphs	base64encoded	Usage graph of the last month
stopGameExists	gameservers	bool	Is the gameserver forced stopped.
stopAutoRestartExists	gameservers	bool	Is the auto restart enabled or disabled.
tickRate	gameservers	int	Tickrate for this server. (optional)

Example

POST

getServersByIp

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

details

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

Request parameters

Parameter	Type	Description
ip	string	IP address of the game server
gamePort	int	Game port of the game server (optional)
adminPort	int	Admin port of the game server (optional)
queryPort	int	Query port of the game server (optional)
incGraph	int	(optional) Include usage graph image data if 1.

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
liveSessionData	gameservers	string	Live session data of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
usageDisk	gameservers	int	Hard disk usage
stopGameExists	gameservers	bool	Is the gameserver forced stopped.
stopAutoRestartExists	gameservers	bool	Is the auto restart enabled or disabled.
tickRate	gameservers	int	Tickrate for this server. (optional)

Example

POST

getUsageGraphs

Get daily, weekly and monthly usage graphs

details

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

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server.

Response parameters

Parameter	Context	Type	Description
usageGraphs		array	List of game servers
graphDay	usageGraphs	base64encoded	Usage graph of the last 24 hours
graphWeek	usageGraphs	base64encoded	Usage graph of the last week
graphMonth	usageGraphs	base64encoded	Usage 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)

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
liveInfo		array	Container for live information
ip	liveInfo	string	IP of the game server
port	liveInfo	int	Game port of the server
hostname	liveInfo	string	Game server name
map	liveInfo	string	Name of the currently selected map
numPlayers	liveInfo	int	Live player count
maxPlayers	liveInfo	int	Maximum number of slots
ping	liveInfo	string	Latency

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)

details

Request parameters

Parameter	Context	Type	Description
No parameters

Response parameters

Parameter	Context	Type	Description
gameservers		array	List of game servers
serverId	gameservers	int	Id of the physical server
isVirtual	gameservers	int	Deployed on a 0: bare metal server, 1: virtual server
gameserverId	gameservers	int	ID of the game server
dedicatedId	gameservers	int	ID of the dedicated server. Returned only if you are the dedicated server owner
serverName	gameservers	string	Name of the physical server
physicalLiveHostname	gameservers	string	Live host name of the physical server - Only for premium users
i3dMonitorVersion	gameservers	string	i3D.net Monitor version string - Only for premium users
i3dServerMonitorVersion	gameservers	string	i3D.net Server Monitor version string - Only for premium users
gameId	gameservers	int	ID of the game title
gameName	gameservers	string	Game title
ip	gameservers	string	Game server IP
port	gameservers	int	Game server network port
queryPort	gameservers	int	Game server query port
hostName	gameservers	string	Name of the game server
locationId	gameservers	int	Location ID of the server
location	gameservers	string	Location of the server
locationFull	gameservers	string	Full location name of the server
serviceParameters	gameservers	string	Startup string
networkSecondaryIp	gameservers	string	Secondary IP of the gameserver
livePlayers	gameservers	int	Number of players on the host
maxPlayers	gameservers	int	Maximum slots
online	gameservers	int/string	Online = 1, offline = 0, Manually stopped = manualstopped, Unknown = unknown
lastOnline	gameservers	int	Last online time in timestamp format
liveVersion	gameservers	string	Version string of the running game
gameVersion	gameservers	string	Version string of the installed game
liveMap	gameservers	string	Live map of the running game
uptime	gameservers	int	Uptime in seconds
rules	gameservers	array	Array of game server rules (configuration)
usageCpu	gameservers	int	CPU usage
usageMemory	gameservers	int	Memory usage
usageDisk	gameservers	int	Hard disk usage

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [gameservers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => _ID_
                            [isVirtual] => 0
                            [gameserverId] => _ID_
                            [dedicatedId] => _ID_
                            [serverName] => _SERVER-NAME_
                            [physicalLiveHostname] => Live name
                            [i3dMonitorVersion] => 6.08
                            [i3dServerMonitorVersion] => 5.26
                            [gameId] => 152
                            [gameName] => Minecraft
                            [ip] => 203.0.113.2
                            [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.

details

Request parameters

Parameter	Context	Type	Description
gameId		int	Id of the game

Response parameters

Parameter	Context	Type	Description
crashes		int	The 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

details

Request parameters

Parameter	Type	Description
gameId	int	Id of the game.
limit	int	(optional) Limit the amount of crashes to retreive, maximum and default is 75000.
offset	int	(optional) Offset from where to start retreiving the amount of crashes, will return 0 if offset is larger than amount of crashes.

Response parameters

Parameter	Type	Description
crashId	int	The ID of the crash
gameId	int	The ID of the game
gameserverId	int	The ID of the gameserver
serverId	int	The ID of the server
MapName	string	The name of the map
gameMode	string	The game mode
livePlayers	int	Amount of live players
liveVersion	string	Live version
userNote	string	Notes
CrashTime	int	Time of the crash

Example

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

        )

)

POST

start

Start game server

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
start		array	Container for result
instructionSent	start	int	1

Example

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

        )

)

POST

restart

Restart game server

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
restart		array	Container for result
instructionSent	restart	int	1

Example

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

        )

)

POST

softRestart

Restart game server using the soft restart method

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
seconds		int	(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server

Response parameters

Parameter	Context	Type	Description
restart		array	Container for result
instructionSent	restart	int	1
msg	restart	string	A 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

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
seconds		int	(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server

Response parameters

Parameter	Context	Type	Description
restart		array	Container for result
instructionSent	restart	int	1
msg	restart	string	A 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

details

Request parameters

Parameter	Type	Description
servers	array	Array with multiple server ip and port
ip	string	IP address of the game server
port	int	Game port of the game server (optional)

Response parameters

Parameter	Context	Type	Description
restart		array	Container for result
instructionSent	restart	int	1

Example

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

        )

)

POST

stop

Stop game server

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
stop		array	Container for result
instructionSent	stop	int	1

Example

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

        )

)

POST

softStop

Stop gameserver using the soft stop method.

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
seconds		int	(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server

Response parameters

Parameter	Context	Type	Description
stop		array	Container for result
instructionSent	stop	int	1
msg	stop	string	A 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

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
seconds		int	(optional) If applicable to the type of game server, the number of seconds to wait before forcefully stopping the game server

Response parameters

Parameter	Context	Type	Description
stop		array	Container for result
instructionSent	stop	int	1
msg	stop	string	A 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

details

Request parameters

Parameter	Type	Description
gameserverId	int	ID of the game server
methodId	int	ID the action method
seconds	int	(optional) shutdown in maximum amount of seconds

Response parameters

Parameter	Context	Type	Description
executeActionMethod		array	Container for result
instructionSent	executeActionMethod	int	1

Example

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

        )

)

POST

getAllActionMethods

Get all available action methods for this game server

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
methods		array	Container 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

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
start		array	Container for result
instructionSent	enableAutoRestart	int	1

Example

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

        )

)

POST

disableAutoRestart

Disable auto restart for the game server

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
start		array	Container for result
instructionSent	disableAutoRestart	int	1

Example

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

        )

)

POST

getConfig

Get a configuration file

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
gameconfigName		string	Name of the configuration file you want to retrieve

Response parameters

Parameter	Context	Type	Description
config		array	Container for the result
gameconfigId	config	int	ID of this configuration file
gameconfig	config	string	The contents of the config file
gameconfigCanEdit	config	string	Whether 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

details

Request parameters

Parameter	Type	Description
gameserverId	int	ID of the game server
gameconfigName	string	Name of the configuration file you want to update
gameconfig	string	The contents of the configuration file, base64 encoded
restart (optional)	int	If 1, the game server will be restarted after config update

Response parameters

Parameter	Context	Type	Description
updateConfig		array	Container for the result
result	updateConfig	string	The 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

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
liveState		int	The live state of the game server

Response parameters

Parameter	Context	Type	Description
setLiveState		array	Container for result
result	setLiveState	int	1

Example

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

        )

)

POST

setLiveSessionData

Set the live session data for the game server

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
liveSessionData		string	The live session data of the game server

Response parameters

Parameter	Context	Type	Description
setLiveSessionData		array	Container for result
result	setLiveSessionData	int	1

Example

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

        )

)

POST

getAvailableInstalls

Get available software installs / updates for a game server

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server

Response parameters

Parameter	Context	Type	Description
installs		array	Container for result
installId	installs	int	ID of the install / update
name	installs	int	Name of the install / update
version	installs	int	Version string
isupdate	installs	int	Is 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

details

Request parameters

Parameter	Context	Type	Description
gameserverId		int	ID of the game server
installId		int	ID of the software install / update

Response parameters

Parameter	Context	Type	Description
install		array	Container for result
instructionSent	install	int	0 or 1

Example

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

                )

        )

)

Game server API calls

Actions

Control

Install