特定サーバー起動

警告: この API ドキュメントは Clanforge 用です。Multiplay Hosting を使用している場合は、Multiplay Hosting API のドキュメント を参照してください。

<serverid> によって識別されるゲームサーバーを起動します。ゲームサーバーがすでに起動している場合、このエンドポイントの影響はありません。

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

メソッド

GET

リクエストパラメーター

変数説明任意
serverid<serverid> パラメーターには、起動するサーバーの ID を指定します。いいえ

レスポンスフィールド

フィールド説明任意
actionstringサーバーに対して実行されるアクション。このエンドポイントでは "start"いいえ
successbooleanアクションが成功したかどうかを示すブーリアンいいえ
serverobjectサーバーに関する情報を含むサーバーオブジェクトいいえ

サーバーオブジェクト

フィールド説明任意
serveridintegerサーバーの IDいいえ

リクエストの例

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>
    }
}