Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Server list V3

Documentation for Server list V3
Read time 1 minuteLast updated 4 hours ago
Get a paginated list of all game servers that match the criteria passed through the parameters. 
https://api.multiplay.co.uk/cfp/v3/servers
METHOD
GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
last_idThe last value of the server_id field on the previous page.Required if paging
last_valThe last value of the sort column on the previous page. The sort column is server_id by default.Required if paging
sort_dirThe sort direction of the results. Valid values are 
asc
for ascending and 
desc
for descending.		Yes
sort_byThe column to sort by. You can sort by 
serverid
, 
name
, 
profileid
, 
machineid
. It uses 
serverid
to sort by default.		Yes
limitThe number of results on each page. The default page size is 
100
. The maximum page size is 
1000
.		Yes

Response fields

FieldTypeDescriptionOptional
machine_idintegerID of the machine this server is onNo
namestringName of this serverYes
deletedstringShows the date when this server was deletedYes
profile_idintegerID of the profile used by this serverYes
server_idintegerID of this serverYes

Example requests

curl --location --request GET  'https://api.multiplay.co.uk/cfp/v3/servers?sort_by=<sort_by>&sort_dir=<sort_dir>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
The following example shows how to get the next page of servers sorted by inverse name. Here, 
last_id
is set to 
30
to indicate that 30 was the ID of the previous page and 
last_val
is set to the last server name (
svrname
). 
curl --location --request GET  'https://api.multiplay.co.uk/cfp/v3/servers?/cfp/v3/servers?sort_by=name&sort_dir=desc&last_id=30&last_val=svrname \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    data: [
        {
            "server_id": <server_id>,
            "machine_id": <machine_id>,
            "name": <server_name>,
            "deleted": <deleted_date>,
            "profile_id": <profile_id>
        },
        ...
    ]
}