DIAMONDHOSTDevelopers
Minecraft 專用
模組包、MCLogs、版本切換與玩家管理 API。
模組包管理
GET
/?provider=modrinth&page=1&page_size=20&search_query=vanilla搜尋模組包
依供應商、頁碼與關鍵字搜尋可安裝的模組包。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/?provider=modrinth&page=1&page_size=20&search_query=vanilla" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/versions?provider=modrinth&modpack_id=AANobbMI取得模組包版本
列出指定供應商與模組包的可用版本。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/versions?provider=modrinth&modpack_id=AANobbMI" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/status取得安裝狀態
回傳目前安裝步驟、錯誤與完成狀態。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/status" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"POST
/install安裝模組包
下載指定版本;可選擇是否先刪除既有伺服器檔案。
REQUEST BODY
{
"provider": "modrinth",
"modpack_id": "AANobbMI",
"modpack_version_id": "3.0.2",
"delete_server_files": false
}程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/install" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"provider": "modrinth",
"modpack_id": "AANobbMI",
"modpack_version_id": "3.0.2",
"delete_server_files": false
}'MCLogs 日誌管理
GET
/列出已上傳日誌
列出伺服器先前上傳至 mclo.gs 的日誌記錄。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/settings取得日誌設定
回傳每台伺服器可保留的日誌數量上限。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/settings" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/scan掃描日誌檔案
掃描伺服器內可供上傳的日誌檔案。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/scan" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"POST
/upload上傳日誌內容
將文字內容上傳至 mclo.gs,log_type 為選填分類。
REQUEST BODY
{
"content": "[Server thread/INFO]: Done (2.314s)!",
"log_type": "latest"
}程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/upload" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"content": "[Server thread/INFO]: Done (2.314s)!",
"log_type": "latest"
}'POST
/upload-file上傳指定日誌檔
讀取伺服器內指定路徑的日誌並上傳至 mclo.gs。
REQUEST BODY
{ "file_path": "/logs/latest.log" }程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/upload-file" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "file_path": "/logs/latest.log" }'DELETE
/{log}刪除日誌記錄
刪除指定的日誌上傳記錄。
程式範例cURL / Node.js / Python
curl -X DELETE "${BASE_URL}/{log}" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"版本切換
GET
/installed取得已安裝版本
回傳目前核心類型、版本與 build 資訊。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/installed" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"POST
/install安裝新版本
使用 build ID 安裝版本,並確認 EULA 與檔案處理方式。
REQUEST BODY
{
"build": 123,
"delete_files": false,
"accept_eula": true
}程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/install" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"build": 123,
"delete_files": false,
"accept_eula": true
}'GET
/install/status/{installation}取得版本安裝狀態
以 installation ID 查詢安裝進度。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/install/status/{installation}" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/install/latest取得最近安裝記錄
取得最近一次版本安裝工作。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/install/latest" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/types列出核心類型
列出 Vanilla、Paper、Purpur、Forge、Fabric 等可用核心。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/types" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/types/{type}列出核心版本
列出指定核心類型的可用版本。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/types/{type}" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/types/{type}/{version}列出版本 Builds
列出指定核心版本的可用 build。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/types/{type}/{version}" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"玩家管理
GET
/取得玩家與權限狀態
回傳線上玩家、OP、白名單與封鎖清單。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/skin取得玩家皮膚頁面
回傳玩家管理器使用的皮膚 HTML。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/skin" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/offline列出離線玩家
從世界玩家資料中列出目前離線的玩家。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/offline" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"GET
/stats/{uuid}取得玩家資料
取得指定 UUID 的統計與 NBT 玩家資料。
程式範例cURL / Node.js / Python
curl -X GET "${BASE_URL}/stats/{uuid}" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json"POST
/whitelist/status切換白名單
啟用或停用伺服器白名單。
REQUEST BODY
{ "enabled": true }程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/whitelist/status" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "enabled": true }'PUT
/whitelist加入白名單
依 Minecraft 玩家名稱加入白名單。
REQUEST BODY
{ "name": "Steve" }程式範例cURL / Node.js / Python
curl -X PUT "${BASE_URL}/whitelist" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "name": "Steve" }'DELETE
/whitelist移出白名單
依玩家 UUID 從白名單移除。
REQUEST BODY
{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }程式範例cURL / Node.js / Python
curl -X DELETE "${BASE_URL}/whitelist" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }'PUT
/op授予 OP
依玩家名稱授予 OP 權限。
REQUEST BODY
{ "name": "Steve" }程式範例cURL / Node.js / Python
curl -X PUT "${BASE_URL}/op" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "name": "Steve" }'DELETE
/op移除 OP
依玩家 UUID 移除 OP 權限。
REQUEST BODY
{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }程式範例cURL / Node.js / Python
curl -X DELETE "${BASE_URL}/op" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }'PUT
/ban封鎖玩家
依玩家名稱封鎖並記錄原因。
REQUEST BODY
{ "name": "Steve", "reason": "Griefing" }程式範例cURL / Node.js / Python
curl -X PUT "${BASE_URL}/ban" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "name": "Steve", "reason": "Griefing" }'DELETE
/ban解除玩家封鎖
依玩家 UUID 解除封鎖。
REQUEST BODY
{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }程式範例cURL / Node.js / Python
curl -X DELETE "${BASE_URL}/ban" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }'PUT
/ban-ip封鎖 IP
封鎖指定 IP,reason 為選填。
REQUEST BODY
{ "ip": "203.0.113.10", "reason": "Abuse" }程式範例cURL / Node.js / Python
curl -X PUT "${BASE_URL}/ban-ip" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "ip": "203.0.113.10", "reason": "Abuse" }'DELETE
/ban-ip解除 IP 封鎖
解除指定 IP 的封鎖。
REQUEST BODY
{ "ip": "203.0.113.10" }程式範例cURL / Node.js / Python
curl -X DELETE "${BASE_URL}/ban-ip" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "ip": "203.0.113.10" }'PUT
/ban-ip-player封鎖玩家 IP
依玩家 UUID 封鎖該玩家使用的 IP。
REQUEST BODY
{
"uuid": "8667ba71-b85a-4004-af54-457a9734eed7",
"reason": "Ban evasion"
}程式範例cURL / Node.js / Python
curl -X PUT "${BASE_URL}/ban-ip-player" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"uuid": "8667ba71-b85a-4004-af54-457a9734eed7",
"reason": "Ban evasion"
}'POST
/kick踢出玩家
依玩家 UUID 將線上玩家踢出伺服器。
REQUEST BODY
{
"uuid": "8667ba71-b85a-4004-af54-457a9734eed7",
"reason": "Server maintenance"
}程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/kick" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"uuid": "8667ba71-b85a-4004-af54-457a9734eed7",
"reason": "Server maintenance"
}'POST
/kill殺死玩家
依玩家 UUID 執行 kill。
REQUEST BODY
{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/kill" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }'POST
/clear清空玩家背包
依玩家 UUID 清除背包物品。
REQUEST BODY
{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/clear" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }'POST
/wipe清除玩家資料
依玩家 UUID 清除玩家資料。
REQUEST BODY
{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/wipe" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{ "uuid": "8667ba71-b85a-4004-af54-457a9734eed7" }'POST
/set-stat設定玩家屬性
修改遊戲模式、經驗、位置、生命、飽食度或物品欄資料。
REQUEST BODY
{
"uuid": "8667ba71-b85a-4004-af54-457a9734eed7",
"key": "gamemode",
"value": "creative"
}程式範例cURL / Node.js / Python
curl -X POST "${BASE_URL}/set-stat" \
-H "Authorization: Bearer ${API_KEY}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"uuid": "8667ba71-b85a-4004-af54-457a9734eed7",
"key": "gamemode",
"value": "creative"
}'