Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Server locations

Documentation for Server locations
Read time 1 minuteLast updated 8 hours ago
Get a list of game server locations. 
https://api.multiplay.co.uk/cfp/v1/server/locations
METHOD
GET

Request parameters

VARIABLE
DESCRIPTION
OPTIONAL
accountserviceid
The 
<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

locations
array
List of location objects containing the name and ID of the server location.
No

Locations object

Field

Type

Description

Optional

locationid
string
ID of the location of this server
No
name
string
Name of the location
No

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