保存服务器

警告:此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting,请参阅 Multiplay Hosting API 文档

使用通过参数传递的详细信息来更新通过 <serverid> 确定的游戏服务器。所有参数都是可选的。

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

方法

GET

请求参数

变量描述可选
serverid要保存的游戏服务器的 ID。
profileid用来更改服务器的配置文件的 ID。
name分配至游戏服务器的名称字符串。它可以包含服务器变量,例如 $$location$$
active在游戏服务器上执行服务器操作。
  • 0 = 停止服务器
  • 1 = 启动服务器
  • 2 = 自动重启(如果服务器发生了更改)
  • 3 = 重启服务器
  • 4 = 仅在配置文件更改时停止服务器

如果未指定操作,游戏服务器将保持当前状态。

如果指定的 profileid 与游戏服务器当前运行的配置文件不同,Clanforge 将重启该游戏服务器,以应用新的配置文件,除非您将此参数设为 4,这将阻止游戏服务器在配置文件更改时重启。

响应字段

字段类型描述可选
success布尔值表示操作是否成功的标志。
server对象服务器对象,其中包含服务器的相关信息。

服务器对象

字段类型描述可选
profileid整数服务器当前所用配置文件的 ID。
serverid整数服务器的 ID。
name字符串游戏服务器的名称,这通常是在创建时自动生成的。

请求示例

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/<serverid>/save?profileid=<profileid>&active=<active>&name=<name>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

响应示例

{
    "success": true,
    "server": {
        "profileid": <profileid>,
        "serverid": <serverid>,
        "name": <name>
    }
}