Server stop

Documentation for Server stop

Read time 1 minute

Last updated 4 hours ago

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

PARAMETER	DESCRIPTION	OPTIONAL
serverid	The `<serverid>` parameter accepts the ID of the server to stop	No

Field	Type	Description	Optional
action	string	Action performed on the server. Will be `stop` for this endpoint.	No
success	boolean	Boolean indicating whether the action was successful	No
server	object	Server object containing information about the server	No

Field	Type	Description	Optional
serverid	integer	ID of the server	No


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


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