Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Fleet profile switch status

Documentation for Fleet profile switch status
Read time 1 minuteLast updated 3 hours ago
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
GET
application/json

Request parameters

VARIABLE
DESCRIPTION
OPTIONAL
fleetID
Fleet ID to check the current switch status of that fleet's profile.
No

Response fields

Field

Type

Description

Optional

ServersPending
number
Number of servers still to be processed.
No
ServersProcessed
number
Number of servers that have been processed.
No
ProfileID
number
The ID of the profile.
No
State
string
The current state of the switch. The following possible values can be set: 
pending
, 
processing
, 
complete
, 
not requested
.
No
Deadline
string
The 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>
}