Server locations

Warning: The API documentation here is for Managed Game Server Hosting (Clanforge). If you’re using Game Server Hosting (Multiplay), refer to the Game Server API documentation.

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

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

Locations object

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