Server stop
Documentation for Server stop
Stop the game server identified by . If the specified game server is already stopped, this endpoint does nothing.
https://api.multiplay.co.uk/cfp/v1/server/<serverid>/stop
Request parameters
| PARAMETER | DESCRIPTION | OPTIONAL |
| serverid | The parameter accepts the ID of the server to stop | No |
Response fields
Field | Type | Description | Optional |
|---|
| action | string | Action performed on the server. Will be for this endpoint. | No |
| success | boolean | Boolean indicating whether the action was successful | No |
| server | object | Server object containing information about the server | No |
Server object
Field | Type | Description | Optional |
|---|
| serverid | integer | ID of the server | No |
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> }}