Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Server locations

Documentation for Server locations
Read time 1 minuteLast updated 2 months ago
Get a list of game server locations. 
https://api.multiplay.co.uk/cfp/v1/server/locations
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

Response fields

Field

Type

Description

Optional

locationsarrayList of location objects containing the name and ID of the server location.No

Locations object

Field

Type

Description

Optional

locationidstringID of the location of this serverNo
namestringName of the locationNo

Example request

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

Example response

{
    "locations": [
        {
            "locationid": <locationid>,
            "name": <name>
        },
        ...
    ]
}