Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Unreserve

Documentation for Unreserve
Read time 1 minuteLast updated a day ago
Unreserve a game server by its 
<serverid>
on a specific machine. You must issue this request from the dedicated game server itself when players leave or the game server is in an idle state. Both the machine ID and server ID are generated on Clanforge and passed through to the game server. 
https://api.multiplay.co.uk/cfp/v1/machine/<machineid>/unreserve_server

METHOD

CONTENT TYPE
GETapplication/x-www-form-urlencoded

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
machineidThe <machineid> parameter accepts an identifier of a machine within a fleet.No
serveridThe <serverid> parameter accepts a game server instance ID of a game server on the specified machine.No

Response fields

FieldTypeDescriptionOptional
uuidstringID of the allocationNo

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/machine/<machineid>/unreserve_server?serverid=<serverid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'\
--header 'Content-Type: application/x-www-form-urlencoded'

Example response

{
    "success": <status>,
    "messages": [],
    "uuid": <uuid>
}