特定サーバー起動#
警告: この API ドキュメントは Clanforge 用です。Multiplay Hosting を使用している場合は、Multiplay Hosting API のドキュメント を参照してください。
<serverid>
によって識別されるゲームサーバーを起動します。ゲームサーバーがすでに起動している場合、このエンドポイントの影響はありません。
https://api.multiplay.co.uk/cfp/v1/server/<serverid>/start
リクエストパラメーター#
変数 | 説明 | 任意 |
serverid | <serverid> パラメーターには、起動するサーバーの ID を指定します。 | いいえ |
レスポンスフィールド#
フィールド | 型 | 説明 | 任意 |
---|
action | string | サーバーに対して実行されるアクション。このエンドポイントでは "start" | いいえ |
success | boolean | アクションが成功したかどうかを示すブーリアン | いいえ |
server | object | サーバーに関する情報を含むサーバーオブジェクト | いいえ |
サーバーオブジェクト#
フィールド | 型 | 説明 | 任意 |
---|
serverid | integer | サーバーの 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>
}
}