客戶端 API (Client API)

歡迎使用鑽石託管 DiamondHost 的客戶端 API 文件。本文件提供了完整的 API 參考指南，整合了原版 Pterodactyl 的標準端點以及鑽石託管特有的客製化擴充端點，供開發人員、自動化腳本或第三方整合工具使用。

所有對客戶端 API 的請求都應使用以下基礎路徑：

https://panel.diamondhost.tw/api/client

身份驗證 (Authentication)

所有的 API 請求都需要透過 Bearer Token 進行身份驗證。您可以在面板的「帳戶設定」->「API 金鑰」中生成您的 API Key。

在發送 HTTP 請求時，請於 Header 中附帶您的 API 金鑰：

Authorization: Bearer <your_api_key_here>
Accept: application/json
Content-Type: application/json

[!WARNING] 請妥善保管您的 API 金鑰。任何擁有此金鑰的人都可以對您的帳戶與伺服器進行完整的讀寫操作，包含刪除備份、控制伺服器開關、修改檔案等。

目錄導覽

請透過側邊欄或下方連結訪問不同類別的 API 詳細文檔：

• 帳戶管理：個人資料變更、2FA 驗證、SSH 金鑰、WebAuthn。
• 伺服器管理與擴充：伺服器資訊、開關機控制、資料庫、檔案管理、排程、網路埠、副使用者、備份、子網域、VSCode 等。
• Minecraft 專用 API：模組包管理器、MCLogs 上傳分析、Minecraft 版本切換器、玩家管理（白名單/OP/Bans等）。

錯誤處理與響應 (Error Handling)

API 遵循標準的 HTTP 狀態碼：

錯誤的回傳格式通常為：

{
  "errors": [
    {
      "code": "NotFoundHttpException",
      "status": "404",
      "detail": "The requested resource could not be found."
    }
  ]
}