Server start by criteria

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.

Start the first inactive game server identified by the criteria passed through the parameters.

https://api.multiplay.co.uk/cfp/v1/server/start

METHOD

GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
accountserviceidAccount service ID to filter servers forNo
gameidGame ID to filter servers forNo
country_codeOptional country code to filter servers for, lookup available in the server countries endpointYes
locationidOptional location ID to filter servers forYes

Response fields

FieldTypeDescriptionOptional
actionstringAction performed on the server. Will be 'start' for this endpointNo
successbooleanBoolean indicating whether the action was successfulNo
serverobjectServer object containing information about the serverNo

Server object

FieldTypeDescriptionOptional
serveridintegerID of the serverNo

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/start?accountserviceid=<accountserviceid>&gameid=<gameid>&locationid=1&country_code=<country_code>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "action": "start",
    "success": true,
    "server": {
        "serverid": <serverid>
    }
}