Server save
Warning: The API documentation here is for Clanforge. If you’re using Multiplay Hosting, refer to the Multiplay Hosting API documentation.
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>/saveMETHOD |
| GET |
Request parameters
| VARIABLE | DESCRIPTION | OPTIONAL |
| serverid | ID of the game server you want to save. | No |
| profileid | ID of the profile to change the server to. | Yes |
| name | A string of the name to assign to the game server. It can include server variables, such as $$location$$. | Yes |
| active | Perform a server action on the game server.
If you don't specify an action, the game server will remain in its current state. If you specify a | Yes |
Response fields
| Field | Type | Description | Optional |
|---|---|---|---|
| success | boolean | Flag representing whether the action has been successful. | No |
| server | object | Server object containing information about the server. | No |
Server object
| Field | Type | Description | Optional |
|---|---|---|---|
| profileid | integer | ID of the profile the server is currently on. | No |
| serverid | integer | ID of the server. | No |
| name | string | Name 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>
}
}