Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Server allocate

Documentation for Server allocate
Read time 1 minuteLast updated 2 months ago
Queue an allocation request. When complete, the first unallocated game server identified by the criteria is allocated with the 
<uuid>
parameter value. You can query the status of outstanding requests with the Server Allocations endpoint.
Note: Prefer the Allocate V2 endpoint. 
https://api.multiplay.co.uk/cfp/v1/server/allocate
METHODCONTENT TYPE
GETapplication/x-www-form-urlencoded

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
fleetidThe 
<fleetid>
 parameter accepts the ID of the fleet to allocate capacity from.		No
regionidThe 
<regionid>
 parameter accepts the ID of the region to use for the allocation. Region IDs are provided by Clanforge and unique to your account.		No
profileidThe 
<profileid>
 parameter accepts the profile ID of the profile the game server should use.		No
uuidThe 
<uuid>
 parameter accepts a UUID to use as the allocation identifier for the game server after the allocation has been fulfilled. This must be a valid UUID that you generate.		No

Response fields

Field

Type

Description

Optional

profileidintegerID of the profile used by this serverNo
uuidstringID of the allocationNo
regionsstringID of regions this game server is inNo
createdstringTime at which the allocation was createdNo
requestedstringTime at which the allocation was requestedNo
readystringTime at which the allocation was marked as ready for playersYes
fleetidstringID of the fleet this server is inNo

Example request

curl --location --request POST 'https://api.multiplay.co.uk/cfp/v1/server/allocate?regionid=<regionid>&profileid=<profileid>&uuid=<uuid>&fleetid=<fleetid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "success": true,
    "messages": [],
    "allocation": {
        "profileid": <profileid>,
        "uuid": <uuid>,
        "regions": <regions>,
        "requested": <daterequested>,
        "created": <datecreated>,
        "fleetid": <fleetid>,
        "ready": <status>
    }
}