Server List

List of servers identified by the criteria.

/cfp/v1/server/list
Method Content Type
GET application/x-www-form-urlencoded
Variable Description Optional
accountserviceid The <accountserviceid> to return servers for no
serverid One or more <serverid>’s to return yes
country_code Return only servers in the location identified by <country_code> yes
locationid Return only servers in the location identified by <locationid> yes
active Return inactive servers only if set to 0 otherwise only return active servers yes
allocated Return unallocated servers only if set to 0 otherwise only return allocated servers. yes
profileid The profile id that is currently in use on the server yes

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>
            }
        },
        ...
    ]
}