Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Reserve

Documentation for Reserve
Read time 1 minuteLast updated 2 hours ago
Reserve a game server specified by 
<serverid>
on the machine specified by 
<machineid>
. Unlike allocations, you must reserve game servers from the dedicated game server when a player joins or the game server is in an active 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>/reserve_server
METHOD
CONTENT TYPE
GET
application/x-www-form-urlencoded

Request parameters

VARIABLE
DESCRIPTION
OPTIONAL
machineid
The 
<machineid>
 parameter accepts an identifier of a machine within a fleet.
No
serverid
The 
<serverid>
 parameter accepts a game server instance ID of a game server on the specified machine.
No

Response fields

Field

Type

Description

Optional

profileid
integer
ID of the profile used by this server
No
uuid
string
ID of the allocation
No
regions
string
ID of regions this game server is in
No
created
string
Time at which the reservation was created
No
requested
string
Time at which the reservation was requested
No
fulfilled
string
Time at which the reservation was fulfilled
No
serverid
integer
ID of the server for this reservation
No
fleetid
string
ID of the fleet this server is in
No
regionid
string
ID of the region this server is in
No
machineid
integer
ID of the machine this server is on
No
ip
string
IP (version 4) address of this game server
No
ipv6
string
IP (version 6) address of this game server (if supported by your fleet)
Yes
game_port
integer
Network port for this game server
No

Example request

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

Example response

{
    "success": <status>,
    "messages": [],
    "allocation": {
        "profileid": <profileid>,
        "uuid": <uuid>,
        "regions": <regions>,
        "created": <created>,
        "requested": <requested>,
        "fulfilled": <fufilled>,
        "serverid": <serverid>,
        "fleetid": <fleetid>,
        "regionid": <regionid>,
        "machineid": <machineid>,
        "ip": <ip>,
        "game_port": <port>
    }
}