Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Server save

Documentation for Server save
Read time 1 minuteLast updated 9 hours ago
Update the game server identified by 
<serverid>
with the information passed through the parameters. All parameters are optional. 
https://api.multiplay.co.uk/cfp/v1/server/<serverid>/save
METHOD
GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
serveridID of the game server you want to save.No
profileidID of the profile to change the server to.Yes
nameA string of the name to assign to the game server. It can include server variables, such as 
$$location$$
.		Yes
activePerform a server action on the game server.

• 
0
= Stop the server
• 
1
= Start the server
• 
2
= Auto restart (if server has changed)
• 
3
= Restart the server
• 
4
= Profile change server stop only

If you don't specify an action, the game server will remain in its current state.

If you specify a 
profileid
that's different from the profile the game server is currently running, Clanforge will restart the game server to apply the new profile unless you set this parameter to 
4
, which will prevent the game server from restarting with a profile change.		Yes

Response fields

FieldTypeDescriptionOptional
successbooleanFlag representing whether the action has been successful.No
serverobjectServer object containing information about the server.No

Server object

FieldTypeDescriptionOptional
profileidintegerID of the profile the server is currently on.No
serveridintegerID of the server.No
namestringName of the game server, this is usually autogenerated at creation time.No

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/<serverid>/save?profileid=<profileid>&active=<active>&name=<name>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "success": true,
    "server": {
        "profileid": <profileid>,
        "serverid": <serverid>,
        "name": <name>
    }
}