Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Server list

Documentation for Server list
Read time 2 minutesLast updated 4 hours ago
Get a list of all game servers that match the criteria passed through the parameters.
Note: Prefer the Server List V3 endpoint. 
https://api.multiplay.co.uk/cfp/v1/server/list
METHOD
GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
accountserviceidThe 
<accountserviceid>
parameter accepts an account service ID (ASID) associated with the specified resource. The credentials in the request header must have access to the ASID to perform the request.		No
serveridThe 
<serverid>
parameter accepts one or more game server IDs.		Yes
country_codeThe 
<country\_code>
parameter accepts a single country code.		Yes
locationidThe 
<locationid>
parameter accepts a single location ID. You can get a list of all location IDs with the Server Location endpoint.		Yes
activeThe 
<active>
parameter accepts a boolean value.

If set to 
1
or excluded, the response will include active game servers and inactive game servers.

If set to 
0
, the response will only include inactive game servers.		Yes
allocatedThe 
<allocated>
parameter accepts a boolean value.

If set to 
1
or excluded, the response will only include allocated game servers.

If set to 
0
, the response will only include unallocated game servers.		Yes
profileidThe 
<profileid>
parameter accepts a profile ID. The response will only include game servers running the specified profile ID.		Yes
query_infoThe 
<query\_info>
parameter accepts a boolean value.

If set to 
1
, the response will include query information about the game servers.

If set to 
0
or excluded, the response won't include query information.		Yes

Response fields

FieldTypeDescriptionOptional
activebooleanStatus of this serverYes
allocated_uuidstringID of the allocationYes
admin_lockedstringAdmin lock means the server is undergoing maintenance or in a state that's unsuitable for a game session.Yes
country_codestringCountry code of this serverYes
game_portintegerNetwork port for this serverNo
ipstringIP (version 4) address of this serverNo
locationidstringID of the location of this serverYes
machineidintegerID of the machine this server is onNo
namestringName of this serverYes
profileidintegerID of the profile used by this serverYes
query_portintegerNetwork port for querying this serverYes
serveridintegerID of this serverYes
query_infoobjectInfo about this gameserver, such as maps and player capacityYes

Query info object

FieldTypeDescriptionOptional
playersintegerNumber of players using this serverNo
max_playersintegerPlayer capacity for this serverNo
mapstringGame map being used by this serverNo
statusstringStatus of this serverNo

Example request

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

Example response

{
    "servers": [
        {
            "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>
            }
        },
        ...
    ]
}