DIAMONDHOSTDevelopers
Client API
使用 Client API 管理帳戶、伺服器與自動化功能。
Client API 提供帳戶、伺服器、檔案、網路、Minecraft 與自動化管理功能,適合腳本、機器人及第三方管理工具。
身份驗證 (Authentication)
所有請求都必須透過 Bearer Token 驗證。登入面板後,前往「帳戶設定」→「API 金鑰」建立金鑰。
在發送 HTTP 請求時,請於 Header 中附帶您的 API 金鑰:
Authorization: Bearer <your_api_key_here>
Accept: application/json
Content-Type: application/jsonAPI 金鑰等同帳戶操作權限。請勿寫入公開儲存庫、前端程式碼或分享給不受信任的第三方。
第一個請求
程式範例cURL / Node.js / Python / Go / Java / C# / PHP
curl -X GET "${BASE_URL}" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"API 分類
帳戶管理個人資料、2FA、WebAuthn、API 與 SSH 金鑰伺服器管理伺服器資訊、資源監控、電源與控制台操作檔案管理瀏覽、讀寫、上下載、壓縮與權限管理資料庫管理建立資料庫、更新密碼與刪除資源備份管理建立、下載、鎖定、還原與刪除備份排程任務建立排程、管理任務與立即執行網路管理分配連接埠、主連接埠與備註設定副使用者管理邀請成員、調整權限與移除使用者流量與子網域流量統計、子網域與 DNS 綁定管理Minecraft API模組包、版本切換、日誌與玩家管理
回應與錯誤處理
API 遵循標準的 HTTP 狀態碼:
| 狀態碼 | 描述 | 原因 |
|---|---|---|
200 OK | 請求成功 | 成功獲取資料或執行操作 |
201 Created | 建立成功 | 成功建立資源(如建立備份或排程) |
204 No Content | 執行成功 | 成功刪除或更新資源且無回傳內容 |
400 Bad Request | 請求錯誤 | 參數格式錯誤或缺少必要欄位 |
401 Unauthorized | 未驗證 | API 金鑰無效或已過期 |
403 Forbidden | 權限不足 | 試圖訪問無權限的伺服器或操作 |
404 Not Found | 找不到資源 | 伺服器不存在或找不到指定的資源 |
429 Too Many Requests | 請求速率限制 | 超過 API 的存取頻率限制 |
500 Internal Server Error | 系統錯誤 | 面板內部發生未預期錯誤 |
錯誤的回傳格式通常為:
{
"errors": [
{
"code": "NotFoundHttpException",
"status": "404",
"detail": "The requested resource could not be found."
}
]
}