DiamondHost Logo鑽石託管 DiamondHost
DIAMONDHOSTDevelopers
API v1控制台

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/json

API 金鑰等同帳戶操作權限。請勿寫入公開儲存庫、前端程式碼或分享給不受信任的第三方。

第一個請求

程式範例cURL / Node.js / Python / Go / Java / C# / PHP
curl -X GET "${BASE_URL}" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"

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."
    }
  ]
}

On this page