Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Server restart

Documentation for Server restart
Read time 1 minuteLast updated 4 hours ago

Restart the game server identified by
<serverid>
.
https://api.multiplay.co.uk/cfp/v1/server/<serverid>/restart
METHOD
GET

Request parameters

PARAMETERDESCRIPTIONOPTIONAL
serveridThe
<serverid>
parameter accepts the ID of the server to restart
No

Response fields

FieldTypeDescriptionOptional
actionstringAction performed on the server. Will be 'restart' 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>/restart' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

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