Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Deallocate V2

Documentation for Deallocate V2
Read time 1 minuteLast updated 8 hours ago
Queue a deallocation request. A deallocation request removes the allocation identified by the criteria passed through the variables. The process of deallocating an allocation deletes the payload associated with the allocation. Refer to Allocations Payload. The Deallocate V2 endpoint differs from the original Server Deallocate endpoint in that it requires the allocation UUID and the fleet ID, and supports the Allocations Payload feature. 
https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/server/deallocate
METHOD
POST

Request parameters

VARIABLE
DESCRIPTION
OPTIONAL
fleetid
The 
<fleetid>
 parameter accepts the ID of the fleet to which the allocation belongs.
No
uuid
The 
<uuid>
 parameter accepts an allocation UUID. The specified UUID is deallocated.
No

Response fields

Field

Type

Description

Optional

uuid
string
ID of the allocation
No

Example request

curl --location --request POST 'https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/server/deallocate?uuid=<uuid> \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

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