保存服务器
警告:此处的 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 | 在游戏服务器上执行服务器操作。
如果未指定操作,游戏服务器将保持当前状态。 如果指定的 | 是 |
响应字段
字段 | 类型 | 描述 | 可选 |
---|---|---|---|
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>
}
}