Server status

Warning: The API documentation here is for Managed Game Server Hosting (Clanforge). If you’re using Game Server Hosting (Multiplay), refer to the Game Server API documentation.

Get the status of the game server identified by <serverid>.

https://api.multiplay.co.uk/cfp/v1/server/<serverid>/status

METHOD

GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
serveridThe <serverid> parameter accepts a game server ID of the game server to retrieve the status of.No
query_infoThe <query_info> parameter allows you to request query information about the game server in addition to the status.

If set to true, the response includes query information and status.

If set to false or excluded, the response includes the game server status.

Yes

Response fields

FieldTypeDescriptionOptional
activeintegerNumber representing activity state, expect 0 for stopped, 1 for started and >=2 for restartingNo
allocated_uuidstringUUID of the allocation this server is currently on or empty string if noneNo
admin_lockedintegerNumber representing lock state, 1 indicates the server is undergoing maintenance or in a state that's currently unsuitable for a game sessionNo
country_codestringTwo letter country code, country lookup available in the server countries endpointNo
game_portintegerPort the game server is available onNo
ipstringIP address the game server is available onNo
locationidstringID of the location the game server is inNo
machineidintegerID of the machine the game server is onNo
namestringName of the game server, this is usually autogenerated at creation timeNo
profileidintegerID of the profile this server is currently onNo
query_portstringPort the game server should be providing query information on via a query protocol such as SQPNo
serveridintegerID of the serverNo
query_infoobjectQuery object containing additional server info if query_info is set on the requestYes

Query object

All fields on the query service are returned directly from the game server's query service at the time of the request. The game must support query for this to function.

FieldTypeDescriptionOptional
playersintegerCurrent number of players on the serverNo
max_playersintegerCurrent maximum match playersNo
mapstringCurrent map nameNo
statusstringCurrent statusNo
namestringCurrent nameNo

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/<serverid>/status?query_info=<query_info>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "server: {
        "active: <active>,
        "allocated_uuid: <allocated_uuid>,
        "admin_locked: <admin_locked>,
        "country_code: <country_code>,
        "game_port: <game_port>,
        "ip: <ip>,
        "locationid: <locationid>,
        "machineid: <machineid>,
        "name: <name>,
        "profileid: <profileid>,
        "query_port: <query_port>,
        "serverid: <serverid>,
        "query_info: {
            "players: <players>,
            "max_players: <max_players>,
            "map: <map>,
            "status: <status>
            "name": <name>
        }
    }
}