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)