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

伺服器管理

查詢伺服器、監控資源、操作電源與傳送控制台指令。

伺服器與資源

GET/

列出可存取的伺服器

回傳目前 API 金鑰可以存取的所有伺服器與基本資源配置。

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

取得伺服器詳細資料

使用伺服器識別碼取得名稱、節點、限制與功能設定。

程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/servers/{server}" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"
GET/servers/{server}/resources

取得即時資源使用量

回傳 CPU、記憶體、硬碟、網路流量與電源狀態。

程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/servers/{server}/resources" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"
GET/servers/{server}/websocket

取得 WebSocket 憑證

回傳具時效性的 Wings WebSocket URL 與驗證 Token。

程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/servers/{server}/websocket" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"

控制操作

POST/servers/{server}/command

傳送控制台指令

向執行中的伺服器傳送一行控制台指令。

REQUEST BODY
{ "command": "say Hello World!" }
程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/servers/{server}/command" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{ "command": "say Hello World!" }'
POST/servers/{server}/power

切換電源狀態

signal 可使用 start、stop、restart 或 kill。

REQUEST BODY
{ "signal": "restart" }
程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/servers/{server}/power" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{ "signal": "restart" }'
GET/servers/{server}/activity

取得活動日誌

列出伺服器近期操作與事件紀錄。

程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/servers/{server}/activity" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"

啟動設定

GET/servers/{server}/startup

取得啟動設定

回傳啟動命令、Docker 映像與可編輯環境變數。

程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/servers/{server}/startup" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"
PUT/servers/{server}/startup/variable

更新環境變數

更新一個允許使用者編輯的啟動變數。

REQUEST BODY
{ "key": "SERVER_JARFILE", "value": "server.jar" }
程式範例cURL / Node.js / Python
curl -X PUT "${BASE_URL}/servers/{server}/startup/variable" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{ "key": "SERVER_JARFILE", "value": "server.jar" }'

On this page