REST API

把你自己的机器人、网站或工具连接到你的服务器。通过 HTTPS 传输 JSON，使用 Bearer 令牌；其中绝不包含玩家 IP 和 BattlEye GUID。

参考

接口

基础 URL https://dayzhub.cloud/api/v1/console · 每分钟 120 次请求。

方法	路径	作用	权限
GET	/openapi.json	本 API 的 OpenAPI 3.1 文件(公开,无需令牌)。	公开
GET	/servers	你的服务器，含状态、玩家、真实 FPS 和运行时间。	读取
GET	/servers/:serverId	单个服务器及所有在线玩家。	读取
GET	/servers/:serverId/players	玩家，含游戏时长、会话、击杀和死亡。	读取
GET	/servers/:serverId/events	日志：join, leave, kill, death, hit, aikill, placement, build, dismantle, destroy, base_hit, chat, admin, system。	读取
GET	/servers/:serverId/bans	服务器所用每个列表中的生效封禁。	读取
GET	/servers/:serverId/bans/:ban	按 ID 查询单个封禁:原因、证据,以及状态为有效、已过期或已撤销。	读取
POST	/servers/:serverId/bans	封禁：{"steamId":"7656…","minutes":0,"reason":"…"}（0 = 永久）。	写入
DELETE	/servers/:serverId/bans/:ban	从服务器自己的列表中解除封禁。	写入
POST	/servers/:serverId/actions	任意运营操作：{"action":"heal","steamId":"7656…"}, "message", "teleport", "give", "kick", "say", "restart"…	写入
POST	/servers/:serverId/kick	踢出玩家,并向其显示原因。	写入
POST	/servers/:serverId/message	向单个玩家发送消息,或向所有人广播。	写入
GET	/servers/:serverId/whitelist	白名单:是否开启以及名单中的玩家。	读取
POST	/servers/:serverId/whitelist	将玩家加入白名单(最多 5000 人)。	写入
DELETE	/servers/:serverId/whitelist/:steamId	将玩家移出白名单(名单开启时无法移除最后一人)。	写入
GET	/servers/:serverId/priority	可跳过排队的优先玩家。	读取
POST	/servers/:serverId/priority	将玩家加入优先名单(最多 1000 人)。	写入
DELETE	/servers/:serverId/priority/:steamId	将玩家移出优先名单。	写入
GET	/servers/:serverId/sessions	从加入到离开的游戏会话,最新的在前。	读取
GET	/servers/:serverId/stats	在线人数与 FPS 历史,每 5 分钟一个数据点。	读取
GET	/servers/:serverId/leaderboard	排行榜:击杀、死亡、游戏时长、最远击杀、K/D、PvE K/D 或感染者击杀。	读取
GET	/servers/:serverId/hud	游戏内排行榜 HUD：七个排行榜的前列玩家，以及所查询玩家的名次。	读取
POST	/servers/:serverId/hud	与 HUD 调用相同，使用 POST（用于 DayZ 游戏服务器）。	读取
GET	/players/lookup	按 SteamID64 或名称在你的所有服务器上查找玩家。	读取

涉及金钱、银行、ATM、车库和基地清除的操作只能在控制面板中执行，不能通过令牌执行。

每个令牌每分钟最多 300 次请求、每天最多 150000 次(查找和日志的计数高于普通读取)。

示例

curl -H "Authorization: Bearer dhca_…" \
  https://dayzhub.cloud/api/v1/console/servers/dhc_demo_survive/events?type=kill&limit=20

openapi.json · 完整文档和客户端示例见 docs/API.md 与 docs/sdk。

访问

令牌

2 个令牌,无固定上限。

Discord bot (read) 读取dhca_…dhca_…d3m0 · 最近使用 -

Stats site (read, one server) 读取 1 台服务器 IP 白名单dhca_…dhca_…f4k3 · 最近使用 - · 到期 2027-02-08

事件

签名 Webhook

将服务器事件以签名 JSON 发送到你自己的网站或机器人:加入、离开、击杀、封禁、服务器状态、举报和警报。

Community dashboard 启用 hooks.demo-dayz.invalid/… · whsec_…whsec_…d3m0 · 玩家加入, 玩家离开, 新增封禁, 服务器离线, 服务器上线 · 所有服务器 · 最近投递 - (200)

每次投递都是带事件 ID 的 JSON,可用来忽略重复。失败的投递会在 30 秒、2 分钟、10 分钟、1 小时和 6 小时后重试;连续失败 20 次后 Webhook 会被关闭。重放窗口:300 秒。

如何校验签名

X-DHC-Signature: t=1760000000,v1=<hex>
v1 = HMAC_SHA256(secret, t + "." + rawBody)