Server start specific

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 game server identified by <serverid>. If the game server is already started, this endpoint has no effect.

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

METHOD

GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
serveridThe <serverid> parameter accepts the ID of the server to startNo

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/<serverid>/start' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

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