Fleet Profile Switch Status

This API method works the same way as the Fleet Profile Switch but uses a GET method instead to get the current status if a switch is in-progress.

Method Content Type
GET application/json
Variable Description Optional
ProfileID The profileid for which a Fleet’s servers should switch to no
Timeout An amount of time to wait before forcibly restarting all remaining servers that are yet to switch profile. no
MaxMachines The maximum amount of machines to process at any one time. Reccomended to use as this affects how many servers will be unavailable for the period of the switch. If undefined, all empty servers are processed at once. yes

Example JSON Payload

    "ProfileID": <profileID>,
    "Timeout": "<time>",
    "MaxMachines": <count>

Example Response

    "ServersPending": <ServersPending>,
    "ServersProcessed": <ServersProcessed>