Server start by criteria
Documentation for Server start by criteria
Read time 1 minute
Start the first inactive game server identified by the criteria passed through the parameters.
https://api.multiplay.co.uk/cfp/v1/server/start
METHOD |
GET |
Request parameters
VARIABLE | DESCRIPTION | OPTIONAL |
accountserviceid | Account service ID to filter servers for | No |
gameid | Game ID to filter servers for | No |
country_code | Optional country code to filter servers for, lookup available in the server countries endpoint | Yes |
locationid | Optional location ID to filter servers for | Yes |
Response fields
Field | Type | Description | Optional |
|---|---|---|---|
action | string | Action performed on the server. Will be 'start' 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/start?accountserviceid=<accountserviceid>&gameid=<gameid>&locationid=1&country_code=<country_code>' \ --header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
Example response
{ "action": "start", "success": true, "server": { "serverid": <serverid> } }