Server deallocate
Warning: The API documentation here is for Clanforge. If you’re using Multiplay Hosting, refer to the Multiplay Hosting API documentation.
Remove an allocation by the allocation UUID.
Note: Prefer the Deallocate V2 endpoint.
If the game session using the specified allocation has completed, the game server hosting the game session is deallocated. If the allocation is in a pending state, the pending allocation is removed.
https://api.multiplay.co.uk/cfp/v1/server/deallocateMETHOD | CONTENT TYPE |
| GET | application/x-www-form-urlencoded |
Request parameters
| VARIABLE | DESCRIPTION | OPTIONAL |
| fleetid | The <fleetid> parameter accepts a fleet ID. The specified fleet ID must be the fleet to which the allocation UUIDs belong. | No |
| uuid | The <uuid> parameter accepts an allocation UUID. The specified UUID will be 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/v1/server/deallocate?uuid=<uuid> \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'Example response
{
"success": true,
"messages": [],
"uuid": <uuid>
}