Server start specific

Documentation for Server start specific

Read time 1 minute

Last updated a month ago

Start the game server identified by

<serverid>

. If the game server is already started, this endpoint has no effect.


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

METHOD

GET

Request parameters

VARIABLE	DESCRIPTION	OPTIONAL
serverid	The `<serverid>` parameter accepts the ID of the server to start	No

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

Field	Type	Description	Optional
serverid	integer	ID of the server	No


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


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