Fleet profile switch status

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.

Get the status of a profile switch triggered by the Fleet Profile Switch endpoint.

https://api.multiplay.co.uk/cfp/v2/fleet/<fleetID>/switchprofile

METHOD

CONTENT TYPE
GETapplication/json

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
fleetIDFleet ID to check the current switch status of that fleet's profile.No

Response fields

FieldTypeDescriptionOptional
ServersPendingnumberNumber of servers still to be processed.No
ServersProcessednumberNumber of servers that have been processed.No
ProfileIDnumberThe ID of the profile.No
StatestringThe current state of the switch. The following possible values can be set: pending, processing, complete, not requested.No
DeadlinestringThe time of the deadline if set if a timeout was set in the switch profile request. The format is 2019-02-28T12:34:03.58Z UTC.Yes

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v2/fleet/<fleetID>/switchprofile' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'\
--header 'Content-Type: application/json'

Example response

{
    "ServersPending": <ServersPending>,
    "ServersProcessed": <ServersProcessed>,
    "ProfileID": <ProfileID>
    "Deadline": <Deadline> 
    "State": <State>
}