Server stop

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.

Stop the game server identified by <serverid>. If the specified game server is already stopped, this endpoint does nothing.

https://api.multiplay.co.uk/cfp/v1/server/<serverid>/stop

METHOD

GET

Request parameters

PARAMETERDESCRIPTIONOPTIONAL
serveridThe <serverid> parameter accepts the ID of the server to stopNo

Response fields

FieldTypeDescriptionOptional
actionstringAction performed on the server. Will be stop for this endpoint.No
successbooleanBoolean indicating whether the action was successfulNo
serverobjectServer object containing information about the serverNo

Server object

FieldTypeDescriptionOptional
serveridintegerID of the serverNo

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/<serverid>/stop' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "action": "stop",
    "success": true,
    "server": {
        "serverid": <serverid>
    }
}