Fleet allocations

Warning: The API documentation here is for Managed Game Server Hosting (Clanforge). If you’re using Game Server Hosting (Multiplay), refer to the Game Server API documentation.

Fleet allocations is a utility endpoint useful for finding allocations for which you don't have the allocation UUID anymore, but have not yet timed out.

Don't use this endpoint as part of a matchmaker flow to monitor allocations. Instead, use Server allocations.

https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/allocations

METHOD

GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
fleetidThe <fleetid> parameter accepts the ID of the fleet to which the allocation belongs.No
ageThe <age> parameter accepts a Golang time.Duration type value representing the minimum time each allocation in the response has been active. For example, providing a value of 24h would return all allocations that have been active for longer than 24 hours).No
limitThe <limit> parameter accepts an integer representing the maximum number of allocations to include in the response. <limit> must be a value between 10 and 50. The default value is 10.Yes
emptyThe <empty> parameter accepts a Boolean value.

If set to true, the response includes only empty allocations.

If set to false or excluded, the response includes empty and non-empty allocations.
Yes

Response fields

FieldTypeDescriptionOptional
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
etastringTime at which the allocation is estimated to be fulfilledNo
fulfilledstringTime at which the allocation was fulfilledNo
readystringTime at which the allocation was marked as ready for playersYes
serveridintegerID of the server for this allocationNo
fleetidstringID of the fleet this server is inNo
regionidstringID of the region this server is inNo
machineidintegerID of the machine this server is onNo
ipstringIP (version 4) address of this game serverNo
ipv6stringIP (version 6) address of this game server (if supported by your fleet)Yes
game_portintegerNetwork port for this game serverNo

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/allocations?age=<age>&limit=<limit>&empty=<empty>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

[
    {
        "profileid": <profileid>,
        "uuid": <uuid>,
        "requestid": <requestid>,
        "regions": <regions>,
        "requested": <requested>,
        "created": <created>,
        "fulfilled": <fulfilled>,
        "eta": <eta>,
        "serverid": <serverid>,
        "fleetid": <fleetid>,
        "regionid": <regionid>,
        "machineid": <machineid>,
        "ip": <ip>,
        "ipv6": <ipv6>,
        "game_port": <port>,
        "ready": <status>
    },
    ...
]